diff --git a/.github/PULL_REQUEST_TEMPLATE/ARM_spec_pr_review_workflow_diagram.png b/.github/PULL_REQUEST_TEMPLATE/ARM_spec_pr_review_workflow_diagram.png index 2c2487a213a3..6705514d73d8 100644 Binary files a/.github/PULL_REQUEST_TEMPLATE/ARM_spec_pr_review_workflow_diagram.png and b/.github/PULL_REQUEST_TEMPLATE/ARM_spec_pr_review_workflow_diagram.png differ diff --git a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md index 4c332b3cbd65..615c0d072e2c 100644 --- a/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/control_plane_template.md @@ -1,10 +1,12 @@ # ARM (Control Plane) API Specification Update Pull Request +> Tip: overwhelmed by all this guidance? See the `Getting help` section at the bottom of this PR description. + ## PR review workflow diagram Please understand this diagram before proceeding. It explains how to get your PR approved & merged. -![diagram](https://github.com/Azure/azure-rest-api-specs/assets/4429827/029a11fd-eaf9-4865-9d77-a16b5ea5eb26) +![diagram](https://github.com/Azure/azure-rest-api-specs/assets/20296335/35140fb9-639e-4e44-ac4b-38b1a20dddf9)
Click here to see the details of Step 1 @@ -36,13 +38,11 @@ If the automation determines you have breaking changes, i.e. Step 1 from the dia ### Diagram footnotes -[1] [ARM review queue] (for **merge** queues, see [4]) +[1] [ARM review queue] (for **merge** queues, see [2]) The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page. If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label `ARMChangesRequested` -is removed from your PR. This should cause the label `WaitForARMFeedback` to be added. -[2] https://aka.ms/azsdk/support/specreview-channel -[3] [List of SDK breaking changes approvers] in pinned Teams announcement -[4] [public repo merge queue], [private repo merge queue] (for **ARM review** queue, [1]) +is removed from your PR. This should cause the label `WaitForARMFeedback` to be added. +[2] [public repo merge queue], [private repo merge queue] (for **ARM review** queue, [1]) If you need further help with anything, see `Getting help` section below. @@ -89,15 +89,15 @@ to get approval. ## Getting help -- For general PR approval workflow, see the diagram at the top of this comment. +- First, please carefully read through this PR description, from top to bottom. Please fill out the `Purpose of this PR` and `Due diligence checklist`. +- 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. - If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. -This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes. + This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes. - If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR. [ARM review queue]: https://github.com/search?q=org%3AAzure+is%3Apr+is%3Aopen+label%3AWaitForARMFeedback+-label%3AIDCDevDiv++draft%3Afalse+sort%3Acreated-asc+&type=pullrequests -[List of SDK breaking changes approvers]: https://teams.microsoft.com/l/message/19:0351f5f9404446e4b4fd4eaf2c27448d@thread.skype/1689115217750?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1689115217750&teamName=Azure%20SDK&channelName=API%20Spec%20Review&createdTime=1689115217750 [public repo merge queue]: https://github.com/Azure/azure-rest-api-specs/pulls?q=is%3Aopen+is%3Apr+label%3AMergeRequested+draft%3Afalse+sort%3Acreated-asc [private repo merge queue]: https://github.com/Azure/azure-rest-api-specs-pr/pulls?q=is%3Aopen+is%3Apr+label%3AMergeRequested+-label%3AApproved-OkToMerge+draft%3Afalse+sort%3Acreated-asc [breaking changes process]: https://eng.ms/docs/cloud-ai-platform/azure-core/azure-core-pm-and-design/trusted-platform-pm-karimb/service-lifecycle-and-actions-team/service-lifecycle-actions-team/apex/media/launchingproductbreakingchanges#breaking-change-process-1 diff --git a/.github/policies/resourceManagement.yml b/.github/policies/resourceManagement.yml index efb319838a86..3f172694e8d5 100644 --- a/.github/policies/resourceManagement.yml +++ b/.github/policies/resourceManagement.yml @@ -2529,16 +2529,7 @@ configuration: then: - removeLabel: label: no-recent-activity - description: - - if: - - payloadType: Pull_Request - then: - - if: - - filesMatchPattern: - pattern: specification/.*(\.tsp|tspconfig.yaml) - then: - - addLabel: - label: TypeSpec + description: - if: - payloadType: Issue_Comment - and: diff --git a/custom-words.txt b/custom-words.txt index 9f2428781b8f..89c5a9705493 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -56,6 +56,7 @@ adla adlarge adls adlsgen +adma adminmanagement adou adsis @@ -181,6 +182,7 @@ appfigures appid appinsights applynetworkconfigurationupdates +approveRollingUpgrade appservice appsettings appsource @@ -214,6 +216,7 @@ asyncoperation asyncrhonously asyncronously atascada +atleast attachednetworks attestationcollateral attestationmechanism @@ -526,6 +529,7 @@ codespaces coffeelake cognitiveservices collectiondetails +cogservice colls colocation cololocation @@ -539,6 +543,7 @@ compilationjobs compilefile compositeentities computervision +computeusage concurrentappend conda configreferences @@ -567,6 +572,7 @@ Contoso's contosodataset contosomedia contributer +CONV convolutional cooldown copyid @@ -734,6 +740,8 @@ deletedstorage deletedwithversions deletefailed deleteissuers +deletejob +deletejobs deleteprivateendpointconnection deletesas deletetype @@ -953,6 +961,8 @@ exploitability exportconfiguration exportdevices exporterrors +exportjob +exportjobs exportstatus externaldatasources externaldnsipaddress01 @@ -1242,6 +1252,7 @@ hypernet hyperparameters hyperparams hyperscale +hyperthread hyperv hypervcollectors iaas @@ -1293,6 +1304,8 @@ immutabilitypolicy importances importcollectors importdevices +importjob +importjobs imsi inari inbuild @@ -1645,6 +1658,7 @@ manytoone mapbox mapconfiguration mapconfigurations +mapextensions mapp mapred mapreduce @@ -2438,6 +2452,8 @@ ruleset rulesets rulestack rulestacks +runasaccount +runasaccounts runbook runbooks runid @@ -2493,6 +2509,7 @@ scsv scvmm sddc sddl +sdflex sdks sdwan searchbuffer @@ -2629,6 +2646,7 @@ snmp snomed snssai sobol +softwareinventories softwareplan sohsv solaris @@ -2770,6 +2788,7 @@ subvolumes subwoofer subword subwords +succeded suceeded sudoer suggesters @@ -3013,6 +3032,7 @@ unrepaired unrestorable unsecure unsubstituted +unsynchronized untagged untracked untrust @@ -3084,9 +3104,11 @@ versioner versionid versionswithin vertica +vffs vfyc vhds vhdx +vmfs videoanalyzer videosearch viewp @@ -3152,11 +3174,13 @@ vpndeviceconfigurationscript vray vrfs vrops +vsan vsphere vsts vstsrm vuln vusers +vvol vwan vxlan w3clogfile @@ -3884,6 +3908,10 @@ usedCPUMHz totalCPUMHz docon DialOut +vectorizers +ONTAP +SVM +SVM's Vectorizable vectorizers Entra diff --git a/documentation/Semantic-and-Model-Violations-Reference.md b/documentation/Semantic-and-Model-Violations-Reference.md index ccee5df8a1aa..f2c6b299dc0d 100644 --- a/documentation/Semantic-and-Model-Violations-Reference.md +++ b/documentation/Semantic-and-Model-Violations-Reference.md @@ -850,7 +850,7 @@ This document lists the set of automated rules that can be validated against swa **Output Message**: Long running operation should return {header} in header but not being provided. -**Description**: Long running operation must return location header or azure-AsyncOperation header in response when this operation is annotated with x-ms-long-running-operation:true. +**Description**: Long running operation must return `Operation-Id`, `Operation-Location`, or `azure-AsyncOperation` header in response when this operation is annotated with x-ms-long-running-operation:true. **How to fix the violation**: Adding one of these headers to the response in example or in traffic payload. Refer to this [example](https://github.com/Azure/azure-rest-api-specs/blob/5e638554b6/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Apps_Update.json#L64) for the fix. diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index f426b165812e..0b928e05dfb8 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -10,9 +10,31 @@ Most guides here require for you to have `npm` installed, which you can get by i ## Spell check -Please add your words to `./custom-words.txt` if you think you have the correct spell. +If you receive a spelling failure either fix the spelling to match or if there are words that need to be suppressed for your service then add the word to the override list in [cspell.json](https://github.com/Azure/azure-rest-api-specs/blob/main/cSpell.json). Either +add to your existing section or create a new section for your specific spec or service family if the work is more generally used in losts of files under your service. +``` + "overrides": [ + ... example of specific file override + { + "filename": "**/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json", + "words": [ + "saskey" + ] + } + ... example of specific service family override + { + "filename": "**/specification/cognitiveservices/**/*.json", + "words": [ + "flac", + "mpga" + ] + } +``` +Words are case-insensitive so use lower case for the word list. + +If you need more information on see [cspell configuration](https://cspell.org/configuration/). -If your problem is some existing error name that is not a word and need to suppress the error in that file (and don't want to add to custom-words.txt), you can add it to `./cSpell.txt`. +*Note*: We are trying to move away from one shared dictionary file so try and avoid editing custom-words.txt in the root as it will likely go away in the future. ## Prettier check diff --git a/eng/pipelines/typespec-validation-all.yml b/eng/pipelines/typespec-validation-all.yml index 305d5b8de581..100546bfe18b 100644 --- a/eng/pipelines/typespec-validation-all.yml +++ b/eng/pipelines/typespec-validation-all.yml @@ -19,6 +19,23 @@ pr: - eng - specification/common-types +resources: + pipelines: + - pipeline: typespec + source: typespec - CI + project: internal + trigger: + branches: + include: + - main + - pipeline: typespec-azure + source: typespec-azure - CI + project: internal + trigger: + branches: + include: + - main + jobs: - job: Validate_All_Specs diff --git a/eng/tools/typespec-validation/src/index.ts b/eng/tools/typespec-validation/src/index.ts index 644a1af53627..895872d4cc1c 100755 --- a/eng/tools/typespec-validation/src/index.ts +++ b/eng/tools/typespec-validation/src/index.ts @@ -6,10 +6,10 @@ import { FormatRule } from "./rules/format.js"; import { GitDiffRule } from "./rules/git-diff.js"; import { LinterRulesetRule } from "./rules/linter-ruleset.js"; import { NpmPrefixRule } from "./rules/npm-prefix.js"; -import path from "path"; import { TsvRunnerHost } from "./tsv-runner-host.js"; export async function main() { + const host = new TsvRunnerHost(); const args = process.argv.slice(2); const options = { folder: { @@ -18,10 +18,10 @@ export async function main() { }, }; const parsedArgs = parseArgs({ args, options, allowPositionals: true } as ParseArgsConfig); - const folder = parsedArgs.positionals[0].split(path.sep).join("/"); - console.log("Running TypeSpecValidation on folder:", folder); + const folder = parsedArgs.positionals[0]; + const absolutePath = host.normalizePath(folder); - const host = new TsvRunnerHost(); + console.log("Running TypeSpecValidation on folder: ", absolutePath); const rules = [ new FolderStructureRule(), @@ -36,7 +36,7 @@ export async function main() { for (let i = 0; i < rules.length; i++) { const rule = rules[i]; console.log("\nExecuting rule: " + rule.name); - const result = await rule.execute(host, folder); + const result = await rule.execute(host, absolutePath); if (result.stdOutput) console.log(result.stdOutput); if (!result.success) { success = false; diff --git a/eng/tools/typespec-validation/src/rules/folder-structure.ts b/eng/tools/typespec-validation/src/rules/folder-structure.ts index ac3c078e3418..da18b9e626c3 100644 --- a/eng/tools/typespec-validation/src/rules/folder-structure.ts +++ b/eng/tools/typespec-validation/src/rules/folder-structure.ts @@ -1,4 +1,3 @@ -import { globby } from "globby"; import path from "path"; import { Rule } from "../rule.js"; import { RuleResult } from "../rule-result.js"; @@ -11,6 +10,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("/"); stdOutput += `folder: ${folder}\n`; if (!(await host.checkFileExists(folder))) { @@ -21,7 +22,7 @@ export class FolderStructureRule implements Rule { }; } - const tspConfigs = await globby([`${folder}/**tspconfig.*`]); + const tspConfigs = await host.globby([`${folder}/**tspconfig.*`]); stdOutput += `config files: ${JSON.stringify(tspConfigs)}\n`; tspConfigs.forEach((file: string) => { if (!file.endsWith("tspconfig.yaml")) { @@ -30,8 +31,8 @@ export class FolderStructureRule implements Rule { } }); - // Verify top level folder is lower case - let folderStruct = folder.split("/"); + // Verify top level folder is lower case and remove empty entries when splitting by slash + let 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`; diff --git a/eng/tools/typespec-validation/src/rules/npm-prefix.ts b/eng/tools/typespec-validation/src/rules/npm-prefix.ts index d9ce18c284f5..6f73792211cc 100644 --- a/eng/tools/typespec-validation/src/rules/npm-prefix.ts +++ b/eng/tools/typespec-validation/src/rules/npm-prefix.ts @@ -1,4 +1,3 @@ -import path from "path"; import { Rule } from "../rule.js"; import { RuleResult } from "../rule-result.js"; import { TsvHost } from "../tsv-host.js"; @@ -13,7 +12,7 @@ export class NpmPrefixRule implements Rule { let expected_npm_prefix: string | undefined; try { // If spec folder is inside a git repo, returns repo root - expected_npm_prefix = path.normalize(await git.revparse("--show-toplevel")); + expected_npm_prefix = host.normalizePath(await git.revparse("--show-toplevel")); } catch (err) { // If spec folder is outside git repo, or if problem running git, throws error return { @@ -22,7 +21,9 @@ export class NpmPrefixRule implements Rule { }; } - const actual_npm_prefix = path.normalize((await host.runCmd(`npm prefix`, folder))[1].trim()); + const actual_npm_prefix = host.normalizePath( + (await host.runCmd(`npm prefix`, folder))[1].trim(), + ); let success = true; let stdOutput = diff --git a/eng/tools/typespec-validation/src/tsv-host.ts b/eng/tools/typespec-validation/src/tsv-host.ts index 1900366a0132..b470537bc40e 100644 --- a/eng/tools/typespec-validation/src/tsv-host.ts +++ b/eng/tools/typespec-validation/src/tsv-host.ts @@ -3,6 +3,8 @@ export interface TsvHost { gitOperation(folder: string): IGitOperation; readTspConfig(folder: string): Promise; runCmd(cmd: string, cwd: string): Promise<[Error | null, string, string]>; + normalizePath(folder: string): string; + globby(patterns: string[]): Promise; } export interface IGitOperation { diff --git a/eng/tools/typespec-validation/src/tsv-runner-host.ts b/eng/tools/typespec-validation/src/tsv-runner-host.ts index a0188d362078..6876528b1168 100644 --- a/eng/tools/typespec-validation/src/tsv-runner-host.ts +++ b/eng/tools/typespec-validation/src/tsv-runner-host.ts @@ -1,8 +1,9 @@ import { join } from "path"; import { readFile } from "fs/promises"; import { IGitOperation, TsvHost } from "./tsv-host.js"; +import { globby } from "globby"; import { simpleGit } from "simple-git"; -import { runCmd, checkFileExists } from "./utils.js"; +import { checkFileExists, normalizePath, runCmd } from "./utils.js"; export class TsvRunnerHost implements TsvHost { checkFileExists(file: string): Promise { @@ -20,4 +21,12 @@ export class TsvRunnerHost implements TsvHost { runCmd(cmd: string, cwd: string): Promise<[Error | null, string, string]> { return runCmd(cmd, cwd); } + + normalizePath(folder: string): string { + return normalizePath(folder); + } + + globby(patterns: string[]): Promise { + return globby(patterns); + } } diff --git a/eng/tools/typespec-validation/src/utils.ts b/eng/tools/typespec-validation/src/utils.ts index 822b433811d3..862bf7cf2d2a 100644 --- a/eng/tools/typespec-validation/src/utils.ts +++ b/eng/tools/typespec-validation/src/utils.ts @@ -1,5 +1,6 @@ import { access } from "fs/promises"; import { exec } from "child_process"; +import path from "path"; export async function runCmd(cmd: string, cwd: string) { console.log(`run command:${cmd}`); @@ -20,3 +21,7 @@ export async function checkFileExists(file: string) { .then(() => true) .catch(() => false); } + +export function normalizePath(folder: string) { + return path.resolve(folder).split(path.sep).join("/"); +} diff --git a/eng/tools/typespec-validation/test/emit-autorest.ts b/eng/tools/typespec-validation/test/emit-autorest.test.ts similarity index 100% rename from eng/tools/typespec-validation/test/emit-autorest.ts rename to eng/tools/typespec-validation/test/emit-autorest.test.ts diff --git a/eng/tools/typespec-validation/test/folder-structure.test.ts b/eng/tools/typespec-validation/test/folder-structure.test.ts new file mode 100644 index 000000000000..e9c430db0d28 --- /dev/null +++ b/eng/tools/typespec-validation/test/folder-structure.test.ts @@ -0,0 +1,173 @@ +import { FolderStructureRule } from "../src/rules/folder-structure.js"; +import { TsvTestHost } from "./tsv-test-host.js"; +import { strict as assert } from "node:assert"; + +describe("folder-structure", function () { + it("should fail if tspconfig has incorrect extension", async function () { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/bar/tspconfig.yml"]; + }; + + const result = await new FolderStructureRule().execute(host, TsvTestHost.folder); + assert(result.errorOutput); + assert(result.errorOutput.includes("Invalid config file")); + }); + + it("should fail if folder under specification/ is capitalized", async function () { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/bar/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + + const result = await new FolderStructureRule().execute(host, "/gitroot/specification/Foo/Foo"); + assert(result.errorOutput); + assert(result.errorOutput.includes("must be lower case")); + }); + + it("should succeed if package folder has trailing slash", async function () { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/bar/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo/Foo/", + ); + assert(result.success); + }); + + it("should fail if package folder is more than 3 levels deep", async function () { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/bar/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo/Foo/Foo", + ); + assert(result.errorOutput); + assert(result.errorOutput.includes("3 levels or less")); + }); + + it("should fail if second level folder not capitalized at after each '.' ", async function () { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/bar/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo.foo", + ); + assert(result.errorOutput); + assert(result.errorOutput.includes("must be capitalized")); + }); + + it("should fail if Shared does not follow Management ", async function () { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/bar/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo.Management.Foo.Shared", + ); + assert(result.errorOutput); + assert(result.errorOutput.includes("should follow")); + }); + + it("should fail if folder doesn't contain main.tsp nor client.tsp", async function () { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/bar/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + host.checkFileExists = async (file: string) => { + if (file.includes("main.tsp")) { + return false; + } else if (file.includes("client.tsp")) { + return false; + } + return true; + }; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo.Management", + ); + + assert(result.errorOutput); + assert(result.errorOutput.includes("must contain")); + }); + + it("should fail if folder doesn't contain examples when main.tsp exists", async function () { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/bar/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + host.checkFileExists = async (file: string) => { + if (file.includes("main.tsp")) { + return true; + } else if (file.includes("examples")) { + return false; + } + return true; + }; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo.Management", + ); + + assert(result.errorOutput); + assert(result.errorOutput.includes("must contain")); + }); + + it("should fail if non-shared folder doesn't contain tspconfig", async function () { + let host = new TsvTestHost(); + host.globby = async () => { + return ["/foo/bar/tspconfig.yaml"]; + }; + host.normalizePath = () => { + return "/gitroot"; + }; + host.checkFileExists = async (file: string) => { + if (file.includes("tspconfig.yaml")) { + return false; + } + return true; + }; + + const result = await new FolderStructureRule().execute( + host, + "/gitroot/specification/foo/Foo.Management", + ); + + assert(result.errorOutput); + assert(result.errorOutput.includes("must contain")); + }); +}); diff --git a/eng/tools/typespec-validation/test/tsv-test-host.ts b/eng/tools/typespec-validation/test/tsv-test-host.ts index d5d02f4d093e..049c1d2c025f 100644 --- a/eng/tools/typespec-validation/test/tsv-test-host.ts +++ b/eng/tools/typespec-validation/test/tsv-test-host.ts @@ -1,4 +1,5 @@ import { IGitOperation, TsvHost } from "../src/tsv-host.js"; +import { normalizePath } from "../src/utils.js"; export class TsvTestHost implements TsvHost { static get folder() { @@ -34,6 +35,10 @@ export class TsvTestHost implements TsvHost { return true; } + normalizePath(folder: string): string { + return normalizePath(folder); + } + async readTspConfig(_folder: string): Promise { // Sample config that should cause all rules to succeed return ` @@ -50,4 +55,8 @@ options: output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" `; } + + async globby(patterns: string[]): Promise { + return Promise.resolve(patterns); + } } diff --git a/eng/tools/typespec-validation/test/util.test.ts b/eng/tools/typespec-validation/test/util.test.ts new file mode 100644 index 000000000000..ff63c25cbac4 --- /dev/null +++ b/eng/tools/typespec-validation/test/util.test.ts @@ -0,0 +1,24 @@ +import { TsvTestHost } from "./tsv-test-host.js"; +import { strict as assert } from "node:assert"; +import process from "process"; + +describe("normalize", function () { + it("should succeed if normalized . and normalized cwd matches", async function () { + let host = new TsvTestHost(); + const dotResult = host.normalizePath("."); + const cwdResult = host.normalizePath(process.cwd()); + assert(dotResult === cwdResult); + }); + + it("should succeed if /foo/bar/ is normalized", async function () { + let host = new TsvTestHost(); + const result = host.normalizePath("/foo/bar/").replace(/^[a-zA-Z]:/g, ""); + assert(result === "/foo/bar"); + }); + + it("should succeed if /foo/bar is normalized", async function () { + let host = new TsvTestHost(); + const result = host.normalizePath("/foo/bar").replace(/^[a-zA-Z]:/g, ""); + assert(result === "/foo/bar"); + }); +}); diff --git a/package-lock.json b/package-lock.json index fe31bc2dd5ae..aa310ac8a823 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "@azure-tools/typespec-autorest": "0.36.1", "@azure-tools/typespec-azure-core": "0.36.0", "@azure-tools/typespec-azure-resource-manager": "0.36.1", - "@azure-tools/typespec-client-generator-core": "0.36.0", + "@azure-tools/typespec-client-generator-core": "0.36.1", "@azure-tools/typespec-providerhub": "0.36.0", "@azure/avocado": "^0.8.4", "@typespec/compiler": "0.50.0", @@ -125,10 +125,14 @@ } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.36.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.36.0.tgz", - "integrity": "sha512-l3DA2nkU3UqxT8fntIdd4QuUhosyRYNA+Ah1PiMvnNfjzFNjy1pTWiFZI7+P3bYR1MfDFCHAzq52Az371Ulu0w==", + "version": "0.36.1", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.36.1.tgz", + "integrity": "sha512-PcPfMFbculXkX+82WjTc6TSd2SWFNGrvifQjq/B+km4MxhT+uJVmXf+D5UVqd9Pna6ftDKJfHJe8mHyBFBf6VQ==", "dev": true, + "dependencies": { + "change-case": "~4.1.2", + "pluralize": "^8.0.0" + }, "engines": { "node": ">=18.0.0" }, @@ -2355,6 +2359,15 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, + "node_modules/pluralize": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", + "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", + "dev": true, + "engines": { + "node": ">=4" + } + }, "node_modules/prettier": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.0.3.tgz", diff --git a/package.json b/package.json index e0d7837b044c..12e3215e5a76 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "@azure-tools/typespec-autorest": "0.36.1", "@azure-tools/typespec-azure-core": "0.36.0", "@azure-tools/typespec-azure-resource-manager": "0.36.1", - "@azure-tools/typespec-client-generator-core": "0.36.0", + "@azure-tools/typespec-client-generator-core": "0.36.1", "@azure-tools/typespec-providerhub": "0.36.0", "@typespec/compiler": "0.50.0", "@typespec/http": "0.50.0", diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/agfood.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/agfood.json new file mode 100644 index 000000000000..827c30508ecc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/agfood.json @@ -0,0 +1,23647 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Azure Data Manager for Agriculture Data Plane Service", + "description": "APIs documentation for Microsoft Azure Data Manager for Agriculture DataPlane Service.", + "version": "2023-11-01-preview" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "paths": { + "/application-data:search": { + "post": { + "tags": [ + "ApplicationData" + ], + "description": "Search for ApplicationData across all parties by intersecting geometry.", + "operationId": "ApplicationData_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFarmOperationQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchApplicationDataQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationDataMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_Search": { + "$ref": "./examples/ApplicationData_Search.json" + } + } + } + }, + "/application-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "ApplicationData" + ], + "description": "Create cascade delete job for application data resource.", + "operationId": "ApplicationData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "applicationDataId", + "description": "Id of the application data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ApplicationData_CreateCascadeDeleteJob": { + "$ref": "./examples/ApplicationData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get cascade delete job for application data resource.", + "operationId": "ApplicationData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/ApplicationData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/application-data/{applicationDataId}": { + "get": { + "tags": [ + "ApplicationData" + ], + "description": "Get a specified application data resource under a particular party.", + "operationId": "ApplicationData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "applicationDataId", + "description": "ID of the application data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_Get": { + "$ref": "./examples/ApplicationData_Get.json" + } + } + }, + "patch": { + "tags": [ + "ApplicationData" + ], + "description": "Creates or updates an application data resource under a particular party.", + "operationId": "ApplicationData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "applicationDataId", + "description": "ID of the application data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "applicationData", + "description": "Application data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + } + }, + "x-ms-examples": { + "ApplicationData_CreateOrUpdate": { + "$ref": "./examples/ApplicationData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ApplicationData" + ], + "description": "Deletes a specified application data resource under a particular party.", + "operationId": "ApplicationData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "applicationDataId", + "description": "ID of the application data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ApplicationData_Delete": { + "$ref": "./examples/ApplicationData_Delete.json" + } + } + } + }, + "/parties/{partyId}/attachments": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Returns a paginated list of attachment resources under a particular party.", + "operationId": "Attachments_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resourceIds", + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "resourceTypes", + "description": "Resource Types of the resource.\r\ni.e. Party, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis, Prescription.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AttachmentListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Attachments_ListByPartyId": { + "$ref": "./examples/Attachments_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/attachments/{attachmentId}": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Gets a specified attachment resource under a particular party.", + "operationId": "Attachments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of the attachment.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_Get": { + "$ref": "./examples/Attachments_Get.json" + } + } + }, + "patch": { + "tags": [ + "Attachments" + ], + "description": "Creates or updates an attachment resource under a particular party.", + "operationId": "Attachments_CreateOrUpdate", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of the attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "file", + "type": "file", + "format": "binary", + "description": "File to be uploaded." + }, + { + "in": "formData", + "name": "resourceId", + "description": "Associated Resource id for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "resourceType", + "description": "Associated Resource type for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "originalFileName", + "description": "Original File Name for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "id", + "description": "Unique id.", + "type": "string" + }, + { + "in": "formData", + "name": "status", + "description": "Status of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdDateTime", + "description": "Date when resource was created.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "modifiedDateTime", + "description": "Date when resource was last modified.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "source", + "description": "Source of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 2 + }, + { + "in": "formData", + "name": "name", + "description": "Name to identify resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "description", + "description": "Textual description of resource.", + "type": "string", + "maxLength": 500, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdBy", + "description": "Created by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "modifiedBy", + "description": "Modified by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "eTag", + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Attachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_CreateOrUpdate": { + "$ref": "./examples/Attachments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Attachments" + ], + "description": "Deletes a specified attachment resource under a particular party.", + "operationId": "Attachments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of the attachment.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_Delete": { + "$ref": "./examples/Attachments_Delete.json" + } + } + } + }, + "/parties/{partyId}/attachments/{attachmentId}/file": { + "get": { + "tags": [ + "Attachments" + ], + "description": "Downloads and returns attachment as response for the given input filePath.", + "operationId": "Attachments_Download", + "produces": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "attachmentId", + "description": "Id of attachment to be downloaded.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "format": "binary", + "type": "file" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Attachments_Download": { + "$ref": "./examples/Attachments_Download.json" + } + } + } + }, + "/chemical-products": { + "get": { + "tags": [ + "ChemicalProducts" + ], + "description": "Returns a paginated list of chemical product resources.", + "operationId": "ChemicalProducts_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "cropIds", + "description": "CropIds of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "brands", + "description": "Brands of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "products", + "description": "Products of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "types", + "description": "Types of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "states", + "description": "States of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "activeIngredients", + "description": "ActiveIngredients of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "specificGravity", + "description": "SpecificGravity of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "formulation", + "description": "Formulation of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "registrationNumber", + "description": "RegistrationNumber of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minReEntryInterval", + "description": "Min ReEntryInterval of chemical product.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "maxReEntryInterval", + "description": "Max ReEntryInterval of chemical product.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "locations", + "description": "Locations of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "companyNames", + "description": "Company names of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "datasetIds", + "description": "Reference dataset id of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "referenceRecordIds", + "description": "Reference record id of chemical product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ChemicalProductListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ChemicalProducts_List": { + "$ref": "./examples/ChemicalProducts_List.json" + } + } + } + }, + "/chemical-products/{chemicalProductId}": { + "get": { + "tags": [ + "ChemicalProducts" + ], + "description": "Gets a specified chemicalProduct resource.", + "operationId": "ChemicalProducts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chemicalProductId", + "description": "Id of the chemicalProduct.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ChemicalProduct" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ChemicalProducts_Get": { + "$ref": "./examples/ChemicalProducts_Get.json" + } + } + }, + "patch": { + "tags": [ + "ChemicalProducts" + ], + "description": "Creates or updates a chemicalProduct resource.", + "operationId": "ChemicalProducts_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chemicalProductId", + "description": "Id of the chemicalProduct resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "chemicalProduct", + "description": "ChemicalProduct resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ChemicalProduct" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ChemicalProduct" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ChemicalProduct" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ChemicalProducts_CreateOrUpdate": { + "$ref": "./examples/ChemicalProducts_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ChemicalProducts" + ], + "description": "Deletes dataset for given chemicalProduct id.", + "operationId": "ChemicalProducts_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chemicalProductId", + "description": "Id of chemicalProduct to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ChemicalProducts_Delete": { + "$ref": "./examples/ChemicalProducts_Delete.json" + } + } + } + }, + "/crop-products": { + "get": { + "tags": [ + "CropProducts" + ], + "description": "Returns a paginated list of crop product resources.", + "operationId": "CropProducts_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "cropIds", + "description": "CropIds of crop product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "brands", + "description": "Brands of crop product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "products", + "description": "Products of crop product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "treatments", + "description": "Treatments of crop product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "traits", + "description": "Traits of crop product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "traitStacks", + "description": "TraitStacks of crop product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "locations", + "description": "Locations of crop product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "companyNames", + "description": "Company names of the crop product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "referenceDatasetIds", + "description": "Reference dataset id of the crop product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "referenceRecordIds", + "description": "Reference record id of the crop product.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropProductListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CropProducts_List": { + "$ref": "./examples/CropProducts_List.json" + } + } + } + }, + "/crop-products/{cropProductId}": { + "get": { + "tags": [ + "CropProducts" + ], + "description": "Gets a specified crop Product resource.", + "operationId": "CropProducts_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropProductId", + "description": "Id of the crop Product.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropProduct" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "CropProducts_Get": { + "$ref": "./examples/CropProducts_Get.json" + } + } + }, + "patch": { + "tags": [ + "CropProducts" + ], + "description": "Creates or updates a crop Product resource.", + "operationId": "CropProducts_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropProductId", + "description": "Id of the crop Product resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "cropProduct", + "description": "Crop Product resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/CropProduct" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CropProduct" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropProduct" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "CropProducts_CreateOrUpdate": { + "$ref": "./examples/CropProducts_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "CropProducts" + ], + "description": "Deletes a specified crop Product resource.", + "operationId": "CropProducts_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropProductId", + "description": "Id of the crop Product.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "CropProducts_Delete": { + "$ref": "./examples/CropProducts_Delete.json" + } + } + } + }, + "/crops": { + "get": { + "tags": [ + "Crops" + ], + "description": "Returns a paginated list of crop resources.", + "operationId": "Crops_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "phenotypes", + "description": "Crop phenotypes of the crop.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "breedingMethods", + "description": "Breeding method of the crop.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "locations", + "description": "Location of the crop.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "referenceDatasetIds", + "description": "Reference dataset id of the crop.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "referenceRecordIds", + "description": "Reference record id of the crop.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CropListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Crops_List": { + "$ref": "./examples/Crops_List.json" + } + } + } + }, + "/crops/{cropId}": { + "get": { + "tags": [ + "Crops" + ], + "description": "Gets a specified crop resource.", + "operationId": "Crops_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the crop.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Crops_Get": { + "$ref": "./examples/Crops_Get.json" + } + } + }, + "patch": { + "tags": [ + "Crops" + ], + "description": "Creates or updates a crop resource.", + "operationId": "Crops_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of the crop resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "crop", + "description": "Crop resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Crop" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Crop" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Crops_CreateOrUpdate": { + "$ref": "./examples/Crops_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Crops" + ], + "description": "Deletes Crop for given crop id.", + "operationId": "Crops_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "cropId", + "description": "Id of crop to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Crops_Delete": { + "$ref": "./examples/Crops_Delete.json" + } + } + } + }, + "/datasets/{datasetId}/records": { + "get": { + "tags": [ + "DatasetRecords" + ], + "description": "Returns a paginated list of records.", + "operationId": "DatasetRecords_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "datasetId", + "description": "dataset id.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "recordFilters", + "description": "Filters on key-value pairs within the Record object.\r\nOnly applicable for first level keys with value of type string, datetime or number.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatasetRecordListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DatasetRecords_List": { + "$ref": "./examples/DatasetRecords_List.json" + } + } + } + }, + "/datasets/{datasetId}/records/{recordId}": { + "get": { + "tags": [ + "DatasetRecords" + ], + "description": "Gets a specified record.", + "operationId": "DatasetRecords_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "datasetId", + "description": "Id of the dataset.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "recordId", + "description": "Id of the record.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatasetRecord" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DatasetRecords_Get": { + "$ref": "./examples/DatasetRecords_Get.json" + } + } + }, + "patch": { + "tags": [ + "DatasetRecords" + ], + "description": "Creates or updates a dataset record.", + "operationId": "DatasetRecords_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "datasetId", + "description": "Id of the dataset resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "recordId", + "description": "Id of the dataset record resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "datasetRecord", + "description": "Dataset record resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetRecord" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatasetRecord" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DatasetRecord" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DatasetRecords_CreateOrUpdate": { + "$ref": "./examples/DatasetRecords_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "DatasetRecords" + ], + "description": "Deletes dataset record for given record id.", + "operationId": "DatasetRecords_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "datasetId", + "description": "Id of dataset the record belongs to.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "recordId", + "description": "Id of the record to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DatasetRecords_Delete": { + "$ref": "./examples/DatasetRecords_Delete.json" + } + } + } + }, + "/datasets": { + "get": { + "tags": [ + "Datasets" + ], + "description": "Returns a paginated list of datasets.", + "operationId": "Datasets_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "type", + "description": "Dataset type.", + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatasetListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Datasets_List": { + "$ref": "./examples/Datasets_List.json" + } + } + } + }, + "/datasets/{datasetId}": { + "get": { + "tags": [ + "Datasets" + ], + "description": "Gets a specified dataset.", + "operationId": "Datasets_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "datasetId", + "description": "Id of the dataset.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Dataset" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Datasets_Get": { + "$ref": "./examples/Datasets_Get.json" + } + } + }, + "patch": { + "tags": [ + "Datasets" + ], + "description": "Creates or updates a dataset.", + "operationId": "Datasets_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "datasetId", + "description": "Id of the dataset resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "dataset", + "description": "Dataset resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Dataset" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Dataset" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Dataset" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Datasets_CreateOrUpdate": { + "$ref": "./examples/Datasets_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Datasets" + ], + "description": "Deletes dataset for given dataset id.", + "operationId": "Datasets_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "datasetId", + "description": "Id of dataset to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Datasets_Delete": { + "$ref": "./examples/Datasets_Delete.json" + } + } + } + }, + "/datasets/{datasetId}/access": { + "get": { + "tags": [ + "Datasets" + ], + "description": "Dataset access list.", + "operationId": "Datasets_ListAuthorizedAccess", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "datasetId", + "description": "Id of dataset to be accessed.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "subscriptionIds", + "description": "Subscription Ids.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "resourceIds", + "description": "Resource Ids.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatasetAccessListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Datasets_ListAuthorizedAccess": { + "$ref": "./examples/Datasets_ListAuthorizedAccess.json" + } + } + } + }, + "/datasets/{datasetId}/access:grant": { + "post": { + "tags": [ + "Datasets" + ], + "description": "Dataset access grant.", + "operationId": "Datasets_AuthorizeAccess", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "datasetId", + "description": "Id of dataset to be accessed.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "datasetAccess", + "description": "Dataset access details.", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetAccess" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatasetAccess" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Datasets_AuthorizeAccess": { + "$ref": "./examples/Datasets_AuthorizeAccess.json" + } + } + } + }, + "/datasets/{datasetId}/access:remove": { + "post": { + "tags": [ + "Datasets" + ], + "description": "Dataset access remove.", + "operationId": "Datasets_RemoveAccess", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "datasetId", + "description": "Id of dataset to be accessed.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "datasetAccess", + "description": "Dataset access details.", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetAccess" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Datasets_RemoveAccess": { + "$ref": "./examples/Datasets_RemoveAccess.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/device-data-models": { + "get": { + "tags": [ + "DeviceDataModels" + ], + "description": "Returns a paginated list of device data model resources.", + "operationId": "DeviceDataModels_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceDataModelListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DeviceDataModels_List": { + "$ref": "./examples/DeviceDataModels_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/device-data-models/{deviceDataModelId}": { + "patch": { + "tags": [ + "DeviceDataModels" + ], + "description": "Create a device data model entity.", + "operationId": "DeviceDataModels_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceDataModelId", + "description": "Id of the device data model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "deviceDataModelObject", + "description": "Device data model object details.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DeviceDataModels_CreateOrUpdate": { + "$ref": "./examples/DeviceDataModels_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "DeviceDataModels" + ], + "description": "Gets a device data model entity.", + "operationId": "DeviceDataModels_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceDataModelId", + "description": "Id of the device data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DeviceDataModels_Get": { + "$ref": "./examples/DeviceDataModels_Get.json" + } + } + }, + "delete": { + "tags": [ + "DeviceDataModels" + ], + "description": "Deletes a device data model entity.", + "operationId": "DeviceDataModels_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceDataModelId", + "description": "Id of the device data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "DeviceDataModels_Delete": { + "$ref": "./examples/DeviceDataModels_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/devices": { + "get": { + "tags": [ + "Devices" + ], + "description": "Returns a paginated list of device resources.", + "operationId": "Devices_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "parentDeviceIds", + "description": "Id's of the parent devices.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "deviceDataModelIds", + "description": "Id's of the device data models.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Devices_List": { + "$ref": "./examples/Devices_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/devices/{deviceId}": { + "patch": { + "tags": [ + "Devices" + ], + "description": "Create a device entity.", + "operationId": "Devices_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceId", + "description": "Id of the device resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "deviceDetails", + "description": "Device object details.", + "required": true, + "schema": { + "$ref": "#/definitions/Device" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Devices_CreateOrUpdate": { + "$ref": "./examples/Devices_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Devices" + ], + "description": "Gets a device entity.", + "operationId": "Devices_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceId", + "description": "Id of the device resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Devices_Get": { + "$ref": "./examples/Devices_Get.json" + } + } + }, + "delete": { + "tags": [ + "Devices" + ], + "description": "Deletes a device entity.", + "operationId": "Devices_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "deviceId", + "description": "Id of the device resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Devices_Delete": { + "$ref": "./examples/Devices_Delete.json" + } + } + } + }, + "/farm-equipments": { + "get": { + "tags": [ + "FarmEquipments" + ], + "description": "Returns a paginated list of farm equipment resources.", + "operationId": "FarmEquipments_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "cropIds", + "description": "CropIds of farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "brands", + "description": "Brands of farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "equipmentSeries", + "description": "Equipment Series of farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "models", + "description": "Model of farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "serial", + "description": "Serial of farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "types", + "description": "Type of farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ownership", + "description": "Ownership of farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "locations", + "description": "Locations of farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "companyNames", + "description": "Company names of farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "referenceDatasetIds", + "description": "Reference dataset id of the farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "referenceRecordIds", + "description": "Reference record id of the farm equipment.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmEquipmentListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FarmEquipments_List": { + "$ref": "./examples/FarmEquipments_List.json" + } + } + } + }, + "/farm-equipments/{farmEquipmentId}": { + "get": { + "tags": [ + "FarmEquipments" + ], + "description": "Gets a specified farm equipment resource.", + "operationId": "FarmEquipments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmEquipmentId", + "description": "Id of the farm equipment.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmEquipment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "FarmEquipments_Get": { + "$ref": "./examples/FarmEquipments_Get.json" + } + } + }, + "patch": { + "tags": [ + "FarmEquipments" + ], + "description": "Creates or updates a farm equipment resource.", + "operationId": "FarmEquipments_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmEquipmentId", + "description": "Id of the farm equipment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "farmEquipment", + "description": "FarmEquipment resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/FarmEquipment" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmEquipment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FarmEquipment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "FarmEquipments_CreateOrUpdate": { + "$ref": "./examples/FarmEquipments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "FarmEquipments" + ], + "description": "Deletes dataset for given farm equipment id.", + "operationId": "FarmEquipments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "farmEquipmentId", + "description": "Id of farm equipment to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "FarmEquipments_Delete": { + "$ref": "./examples/FarmEquipments_Delete.json" + } + } + } + }, + "/farm-operations/ingest-data/{jobId}": { + "put": { + "tags": [ + "FarmOperations" + ], + "description": "Create a farm operation data ingestion job.", + "operationId": "FarmOperations_CreateDataIngestionJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "FarmOperations_CreateDataIngestionJob": { + "$ref": "./examples/FarmOperations_CreateDataIngestionJob.json" + } + } + }, + "get": { + "tags": [ + "FarmOperations" + ], + "description": "Get a farm operation data ingestion job.", + "operationId": "FarmOperations_GetDataIngestionJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmOperationDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "FarmOperations_GetDataIngestionJobDetails": { + "$ref": "./examples/FarmOperations_GetDataIngestionJobDetails.json" + } + } + } + }, + "/farms": { + "get": { + "tags": [ + "Farms" + ], + "description": "Returns a paginated list of farm resources across all parties.", + "operationId": "Farms_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farms_List": { + "$ref": "./examples/Farms_List.json" + } + } + } + }, + "/farms/cascade-delete/{jobId}": { + "put": { + "tags": [ + "Farms" + ], + "description": "Create a cascade delete job for specified farm.", + "operationId": "Farms_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "farmId", + "description": "ID of the farm to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Farms_CreateCascadeDeleteJob": { + "$ref": "./examples/Farms_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "Farms" + ], + "description": "Get a cascade delete job for specified farm.", + "operationId": "Farms_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Farms_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/farms": { + "get": { + "tags": [ + "Farms" + ], + "description": "Returns a paginated list of farm resources under a particular party.", + "operationId": "Farms_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Farms_ListByPartyId": { + "$ref": "./examples/Farms_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/farms/{farmId}": { + "get": { + "tags": [ + "Farms" + ], + "description": "Gets a specified farm resource under a particular party.", + "operationId": "Farms_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "farmId", + "description": "ID of the farm resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_Get": { + "$ref": "./examples/Farms_Get.json" + } + } + }, + "patch": { + "tags": [ + "Farms" + ], + "description": "Creates or updates a farm resource under a particular party.", + "operationId": "Farms_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "farmId", + "description": "Id of the farm resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "farm", + "description": "Farm resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Farm" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Farm" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_CreateOrUpdate": { + "$ref": "./examples/Farms_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Farms" + ], + "description": "Deletes a specified farm resource under a particular party.", + "operationId": "Farms_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "farmId", + "description": "Id of the farm.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Farms_Delete": { + "$ref": "./examples/Farms_Delete.json" + } + } + } + }, + "/fields:search": { + "post": { + "tags": [ + "Fields" + ], + "description": "Search for Fields across all parties by intersecting geometry.", + "operationId": "Fields_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFieldQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchFieldQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FieldMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_Search": { + "$ref": "./examples/Fields_Search.json" + } + } + } + }, + "/fields/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Fields" + ], + "description": "Get a cascade delete job for specified field.", + "operationId": "Fields_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Fields_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Fields" + ], + "description": "Create a cascade delete job for specified field.", + "operationId": "Fields_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "fieldId", + "description": "ID of the field to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Fields_CreateCascadeDeleteJob": { + "$ref": "./examples/Fields_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/fields/{fieldId}": { + "get": { + "tags": [ + "Fields" + ], + "description": "Gets a specified field resource under a particular party.", + "operationId": "Fields_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "fieldId", + "description": "Id of the field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_Get": { + "$ref": "./examples/Fields_Get.json" + } + } + }, + "patch": { + "tags": [ + "Fields" + ], + "description": "Creates or Updates a field resource under a particular party.", + "operationId": "Fields_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "fieldId", + "description": "Id of the field resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "field", + "description": "Field resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Field" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Field" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_CreateOrUpdate": { + "$ref": "./examples/Fields_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Fields" + ], + "description": "Deletes a specified field resource under a particular party.", + "operationId": "Fields_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "fieldId", + "description": "Id of the field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Fields_Delete": { + "$ref": "./examples/Fields_Delete.json" + } + } + } + }, + "/harvest-data:search": { + "post": { + "tags": [ + "HarvestData" + ], + "description": "Search for HarvestData across all parties by intersecting geometry.", + "operationId": "HarvestData_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFarmOperationQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchHarvestDataQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestDataMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_Search": { + "$ref": "./examples/HarvestData_Search.json" + } + } + } + }, + "/harvest-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "HarvestData" + ], + "description": "Create cascade delete job for harvest data resource.", + "operationId": "HarvestData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "harvestDataId", + "description": "Id of the harvest data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "HarvestData_CreateCascadeDeleteJob": { + "$ref": "./examples/HarvestData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get cascade delete job for harvest data resource.", + "operationId": "HarvestData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/HarvestData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/harvest-data/{harvestDataId}": { + "get": { + "tags": [ + "HarvestData" + ], + "description": "Get a specified harvest data resource under a particular party.", + "operationId": "HarvestData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "harvestDataId", + "description": "ID of the harvest data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_Get": { + "$ref": "./examples/HarvestData_Get.json" + } + } + }, + "patch": { + "tags": [ + "HarvestData" + ], + "description": "Creates or updates harvest data resource under a particular party.", + "operationId": "HarvestData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "harvestDataId", + "description": "ID of the harvest data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "harvestData", + "description": "Harvest data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/HarvestData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HarvestData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/HarvestData" + } + } + }, + "x-ms-examples": { + "HarvestData_CreateOrUpdate": { + "$ref": "./examples/HarvestData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "HarvestData" + ], + "description": "Deletes a specified harvest data resource under a particular party.", + "operationId": "HarvestData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "harvestDataId", + "description": "ID of the harvest data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "HarvestData_Delete": { + "$ref": "./examples/HarvestData_Delete.json" + } + } + } + }, + "/image-processing/rasterize/{jobId}": { + "put": { + "tags": [ + "ImageProcessing" + ], + "description": "Create a ImageProcessing Rasterize job.", + "operationId": "ImageProcessing_CreateRasterizeJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ImageProcessing_CreateRasterizeJob": { + "$ref": "./examples/ImageProcessing_CreateRasterizeJob.json" + } + } + }, + "get": { + "tags": [ + "ImageProcessing" + ], + "description": "Get ImageProcessing Rasterize job's details.", + "operationId": "ImageProcessing_GetRasterizeJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ImageProcessingRasterizeJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ImageProcessing_GetRasterizeJob": { + "$ref": "./examples/ImageProcessing_GetRasterizeJob.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments": { + "get": { + "tags": [ + "InsightAttachments" + ], + "description": "Returns a paginated list of insight resources.", + "operationId": "InsightAttachments_ListByPartyIdModelIdAndResource", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "insightIds", + "description": "List of insight IDs.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightAttachmentListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "InsightAttachments_ListByPartyIdModelIdAndResource": { + "$ref": "./examples/InsightAttachments_ListByPartyIdModelIdAndResource.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}": { + "patch": { + "tags": [ + "InsightAttachments" + ], + "description": "Creates or updates insight entity.", + "operationId": "InsightAttachments_CreateOrUpdate", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "file", + "type": "file", + "format": "binary", + "description": "File to be uploaded." + }, + { + "in": "formData", + "name": "insightId", + "description": "InsightID for this InsightAttachment.", + "required": true, + "type": "string" + }, + { + "in": "formData", + "name": "originalFileName", + "description": "Original File Name for this attachment.", + "type": "string" + }, + { + "in": "formData", + "name": "id", + "description": "Unique id.", + "type": "string" + }, + { + "in": "formData", + "name": "status", + "description": "Status of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdDateTime", + "description": "Date when resource was created.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "modifiedDateTime", + "description": "Date when resource was last modified.", + "type": "string", + "format": "date-time" + }, + { + "in": "formData", + "name": "source", + "description": "Source of the resource.", + "type": "string", + "maxLength": 100, + "minLength": 2 + }, + { + "in": "formData", + "name": "name", + "description": "Name to identify resource.", + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + { + "in": "formData", + "name": "description", + "description": "Textual description of resource.", + "type": "string", + "maxLength": 500, + "minLength": 0 + }, + { + "in": "formData", + "name": "createdBy", + "description": "Created by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "modifiedBy", + "description": "Modified by user/tenant id.", + "type": "string" + }, + { + "in": "formData", + "name": "eTag", + "description": "The ETag value to implement optimistic concurrency.", + "type": "string" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_CreateOrUpdate": { + "$ref": "./examples/InsightAttachments_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "InsightAttachments" + ], + "description": "Gets a specified insight resource under a particular party.", + "operationId": "InsightAttachments_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_Get": { + "$ref": "./examples/InsightAttachments_Get.json" + } + } + }, + "delete": { + "tags": [ + "InsightAttachments" + ], + "description": "Deletes a specified insight resource.", + "operationId": "InsightAttachments_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_Delete": { + "$ref": "./examples/InsightAttachments_Delete.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments/{insightAttachmentId}/file": { + "get": { + "tags": [ + "InsightAttachments" + ], + "description": "Downloads and returns insight-attachment as response for the given input filePath.", + "operationId": "InsightAttachments_Download", + "produces": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightAttachmentId", + "description": "Id of the insight attachment resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "format": "binary", + "type": "file" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "InsightAttachments_Download": { + "$ref": "./examples/InsightAttachments_Download.json" + } + } + } + }, + "/insights/cascade-delete/{jobId}": { + "put": { + "tags": [ + "Insights" + ], + "description": "Create a cascade delete job for insights specified partyId/modelId/resourceType/resourceId.", + "operationId": "Insights_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resourceType", + "description": "Resource Type.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "insightId", + "description": "Insight id.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Insights_CreateCascadeDeleteJob": { + "$ref": "./examples/Insights_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "Insights" + ], + "description": "Get a cascade delete job for specified insight.", + "operationId": "Insights_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Insights_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights": { + "get": { + "tags": [ + "Insights" + ], + "description": "Returns a paginated list of insight resources.", + "operationId": "Insights_ListByPartyIdModelIdAndResource", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "minInsightStartDateTime", + "description": "Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxInsightStartDateTime", + "description": "Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minInsightEndDateTime", + "description": "Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxInsightEndDateTime", + "description": "Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "measurementFilters", + "description": "Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object.\r\neg. \"measureKey.unit eq {testValue}\" where testValue is string.\r\neg. \"measureKey.value eq {testValue}\" where testValue = double.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/InsightListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Insights_ListByPartyIdModelIdAndResource": { + "$ref": "./examples/Insights_ListByPartyIdModelIdAndResource.json" + } + } + } + }, + "/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}": { + "patch": { + "tags": [ + "Insights" + ], + "description": "Creates or updates insight entity.", + "operationId": "Insights_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "insightData", + "description": "Insight data.", + "required": true, + "schema": { + "$ref": "#/definitions/Insight" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Insight" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Insight" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_CreateOrUpdate": { + "$ref": "./examples/Insights_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Insights" + ], + "description": "Gets a specified insight resource under a particular party.", + "operationId": "Insights_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Insight" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_Get": { + "$ref": "./examples/Insights_Get.json" + } + } + }, + "delete": { + "tags": [ + "Insights" + ], + "description": "Deletes a specified insight resource.", + "operationId": "Insights_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "modelId", + "description": "Id of the associated model.\r\nIt can be either 'BiomassModelId', 'SensorPlacementModelId', 'SoilMoistureModelId' or any solution id.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceType", + "description": "Resource type associated with the record.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "resourceId", + "description": "Id of the associated resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "insightId", + "description": "Id of the insight resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Insights_Delete": { + "$ref": "./examples/Insights_Delete.json" + } + } + } + }, + "/management-zones": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Returns a paginated list of management zone resources across all parties.", + "operationId": "ManagementZones_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "types", + "description": "Types of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "CropIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "SeasonIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "FieldIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZoneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ManagementZones_List": { + "$ref": "./examples/ManagementZones_List.json" + } + } + } + }, + "/management-zones/cascade-delete/{jobId}": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Get a cascade delete job for specified job id.", + "operationId": "ManagementZones_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_GetCascadeDeleteJobDetails": { + "$ref": "./examples/ManagementZones_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "ManagementZones" + ], + "description": "Create a cascade delete job for specified management zone.", + "operationId": "ManagementZones_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "managementZoneId", + "description": "ID of the management zone to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ManagementZones_CreateCascadeDeleteJob": { + "$ref": "./examples/ManagementZones_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/management-zones": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Returns a paginated list of management zone resources under a particular party.", + "operationId": "ManagementZones_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "types", + "description": "Types of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "CropIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "SeasonIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "FieldIds of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources of the ManagementZone.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZoneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ManagementZones_ListByPartyId": { + "$ref": "./examples/ManagementZones_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/management-zones/{managementZoneId}": { + "get": { + "tags": [ + "ManagementZones" + ], + "description": "Gets a specified management zone resource under a particular party.", + "operationId": "ManagementZones_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "managementZoneId", + "description": "Id of the management zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_Get": { + "$ref": "./examples/ManagementZones_Get.json" + } + } + }, + "patch": { + "tags": [ + "ManagementZones" + ], + "description": "Creates or updates a management zone resource.", + "operationId": "ManagementZones_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "managementZoneId", + "description": "Id of the management zone resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "managementZone", + "description": "ManagementZone resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagementZone" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ManagementZone" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagementZone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_CreateOrUpdate": { + "$ref": "./examples/ManagementZones_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ManagementZones" + ], + "description": "Deletes a specified management zone resource under a particular party.", + "operationId": "ManagementZones_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "managementZoneId", + "description": "Id of the management zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "ManagementZones_Delete": { + "$ref": "./examples/ManagementZones_Delete.json" + } + } + } + }, + "/nutrient-analyses": { + "get": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Returns a paginated list of nutrient analysis resources across all parties.", + "operationId": "NutrientAnalyses_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "parentType", + "description": "Type of the parent it belongs to.\r\ni.e. PlantTissueAnalysis.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Parent ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "classifications", + "description": "Classifications for nutrient analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysisListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NutrientAnalyses_List": { + "$ref": "./examples/NutrientAnalyses_List.json" + } + } + } + }, + "/parties/{partyId}/nutrient-analyses": { + "get": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Returns a paginated list of nutrient analysis resources under a particular party.", + "operationId": "NutrientAnalyses_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "parentType", + "description": "Type of the parent it belongs to.\r\ni.e. PlantTissueAnalysis.", + "type": "string" + }, + { + "in": "query", + "name": "parentIds", + "description": "Parent ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "classifications", + "description": "Classifications for nutrient analyses.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysisListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NutrientAnalyses_ListByPartyId": { + "$ref": "./examples/NutrientAnalyses_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/nutrient-analyses/{nutrientAnalysisId}": { + "get": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Gets a specified nutrient analysis resource under a particular party.", + "operationId": "NutrientAnalyses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "nutrientAnalysisId", + "description": "Id of the nutrient analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "NutrientAnalyses_Get": { + "$ref": "./examples/NutrientAnalyses_Get.json" + } + } + }, + "patch": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Creates or updates a nutrient analysis resource.", + "operationId": "NutrientAnalyses_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "nutrientAnalysisId", + "description": "Id of the nutrient analysis resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "nutrientAnalysis", + "description": "NutrientAnalysis resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "NutrientAnalyses_CreateOrUpdate": { + "$ref": "./examples/NutrientAnalyses_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "NutrientAnalyses" + ], + "description": "Deletes a specified nutrient analysis resource under a particular party.", + "operationId": "NutrientAnalyses_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "nutrientAnalysisId", + "description": "Id of the nutrient analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "NutrientAnalyses_Delete": { + "$ref": "./examples/NutrientAnalyses_Delete.json" + } + } + } + }, + "/oauth/providers": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Returns a paginated list of oauthProvider resources.", + "operationId": "OAuthProviders_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProviderListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OAuthProviders_List": { + "$ref": "./examples/OAuthProviders_List.json" + } + } + } + }, + "/oauth/providers/{oauthProviderId}": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Get a specified oauthProvider resource.", + "operationId": "OAuthProviders_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "ID of the oauthProvider resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_Get": { + "$ref": "./examples/OAuthProviders_Get.json" + } + } + }, + "patch": { + "tags": [ + "OAuthProviders" + ], + "description": "Creates or updates an oauthProvider resource.", + "operationId": "OAuthProviders_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "ID of oauthProvider resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "oauthProvider", + "description": "OauthProvider resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_CreateOrUpdate": { + "$ref": "./examples/OAuthProviders_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "OAuthProviders" + ], + "description": "Deletes an specified oauthProvider resource.", + "operationId": "OAuthProviders_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "oauthProviderId", + "description": "ID of oauthProvider.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_Delete": { + "$ref": "./examples/OAuthProviders_Delete.json" + } + } + } + }, + "/oauth/providers/cascade-delete/{jobId}": { + "get": { + "tags": [ + "OAuthProviders" + ], + "description": "Get cascade delete job for oauthProvider resource.", + "operationId": "OAuthProviders_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthProviderCascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthProviders_GetCascadeDeleteJobDetails": { + "$ref": "./examples/OAuthProviders_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "OAuthProviders" + ], + "description": "Create cascade delete job for oauthProvider resource.", + "operationId": "OAuthProviders_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "oauthProviderId", + "description": "Id of the application data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/OAuthProviderCascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "OAuthProviders_CreateCascadeDeleteJob": { + "$ref": "./examples/OAuthProviders_CreateCascadeDeleteJob.json" + } + } + } + }, + "/oauth/tokens": { + "get": { + "tags": [ + "OAuthTokens" + ], + "description": "Returns a list of OAuthToken documents.", + "operationId": "OAuthTokens_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "authProviderIds", + "description": "Name of AuthProvider.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "partyIds", + "description": "List of parties.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "isValid", + "description": "If the token object is valid.", + "type": "boolean" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OAuthTokenListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OAuthTokens_List": { + "$ref": "./examples/OAuthTokens_List.json" + } + } + } + }, + "/oauth/tokens/:connect": { + "post": { + "tags": [ + "OAuthTokens" + ], + "description": "Returns Connection link needed in the OAuth flow.", + "operationId": "OAuthTokens_GetOAuthConnectionLink", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "oauthConnectRequest", + "description": "OAuth Connect Request.", + "required": true, + "schema": { + "$ref": "#/definitions/OAuthConnectRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthTokens_GetOAuthConnectionLink": { + "$ref": "./examples/OAuthTokens_GetOAuthConnectionLink.json" + } + } + } + }, + "/oauth/tokens/remove/{jobId}": { + "get": { + "tags": [ + "OAuthTokens" + ], + "description": "Get remove job for OAuth token.", + "operationId": "OAuthTokens_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "OAuthTokens_GetCascadeDeleteJobDetails": { + "$ref": "./examples/OAuthTokens_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "OAuthTokens" + ], + "description": "Create remove job for OAuth token.", + "operationId": "OAuthTokens_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "oauthProviderId", + "description": "Id of the OAuthProvider.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "OAuthTokens_CreateCascadeDeleteJob": { + "$ref": "./examples/OAuthTokens_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties": { + "get": { + "tags": [ + "Parties" + ], + "description": "Returns a paginated list of party resources.", + "operationId": "Parties_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PartyListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Parties_List": { + "$ref": "./examples/Parties_List.json" + } + } + } + }, + "/parties:overlap": { + "post": { + "tags": [ + "Parties" + ], + "description": "Returns overlapping area between two resources.", + "operationId": "Parties_GeoOverlap", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "overlapResources", + "description": "Overlap Resources.", + "required": true, + "schema": { + "$ref": "#/definitions/OverlapResourcesQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PartyOverlapResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_GeoOverlap": { + "$ref": "./examples/Parties_GeoOverlap.json" + } + } + } + }, + "/parties/{partyId}": { + "get": { + "tags": [ + "Parties" + ], + "description": "Gets a specified party resource.", + "operationId": "Parties_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Party" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_Get": { + "$ref": "./examples/Parties_Get.json" + } + } + }, + "patch": { + "tags": [ + "Parties" + ], + "description": "Creates or updates a party resource.", + "operationId": "Parties_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "party", + "description": "Party resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Party" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Party" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Party" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_CreateOrUpdate": { + "$ref": "./examples/Parties_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Parties" + ], + "description": "Deletes a specified party resource.", + "operationId": "Parties_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of party to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_Delete": { + "$ref": "./examples/Parties_Delete.json" + } + } + } + }, + "/parties/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Parties" + ], + "description": "Get a cascade delete job for specified party.", + "operationId": "Parties_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Parties_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Parties_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Parties" + ], + "description": "Create a cascade delete job for specified party.", + "operationId": "Parties_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the party to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Parties_CreateCascadeDeleteJob": { + "$ref": "./examples/Parties_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/planting-data/{plantingDataId}": { + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get a specified planting data resource under a particular party.", + "operationId": "PlantingData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantingDataId", + "description": "ID of the planting data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_Get": { + "$ref": "./examples/PlantingData_Get.json" + } + } + }, + "patch": { + "tags": [ + "PlantingData" + ], + "description": "Creates or updates an planting data resource under a particular party.", + "operationId": "PlantingData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantingDataId", + "description": "ID of the planting data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "plantingData", + "description": "Planting data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/PlantingData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PlantingData" + } + } + }, + "x-ms-examples": { + "PlantingData_CreateOrUpdate": { + "$ref": "./examples/PlantingData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PlantingData" + ], + "description": "Deletes a specified planting data resource under a particular party.", + "operationId": "PlantingData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantingDataId", + "description": "ID of the planting data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_Delete": { + "$ref": "./examples/PlantingData_Delete.json" + } + } + } + }, + "/planting-data:search": { + "post": { + "tags": [ + "PlantingData" + ], + "description": "Search for PlantingData across all parties by intersecting geometry.", + "operationId": "PlantingData_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFarmOperationQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchPlantingDataQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantingDataMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_Search": { + "$ref": "./examples/PlantingData_Search.json" + } + } + } + }, + "/planting-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "PlantingData" + ], + "description": "Create cascade delete job for planting data resource.", + "operationId": "PlantingData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "plantingDataId", + "description": "Id of the planting data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PlantingData_CreateCascadeDeleteJob": { + "$ref": "./examples/PlantingData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "PlantingData" + ], + "description": "Get cascade delete job for planting data resource.", + "operationId": "PlantingData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantingData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PlantingData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/plant-tissue-analyses/{plantTissueAnalysisId}": { + "get": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Gets a specified plant tissue analysis resource under a particular party.", + "operationId": "PlantTissueAnalyses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantTissueAnalysisId", + "description": "Id of the plant tissue analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_Get": { + "$ref": "./examples/PlantTissueAnalyses_Get.json" + } + } + }, + "patch": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Creates or updates a plant tissue analysis resource.", + "operationId": "PlantTissueAnalyses_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantTissueAnalysisId", + "description": "Id of the plant tissue analysis resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "plantTissueAnalysis", + "description": "PlantTissueAnalysis resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysis" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_CreateOrUpdate": { + "$ref": "./examples/PlantTissueAnalyses_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Deletes a specified plant tissue analysis resource under a particular party.", + "operationId": "PlantTissueAnalyses_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "plantTissueAnalysisId", + "description": "Id of the plant tissue analysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_Delete": { + "$ref": "./examples/PlantTissueAnalyses_Delete.json" + } + } + } + }, + "/plant-tissue-analyses:search": { + "post": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Search for PlantTissueAnalyses across all parties by intersecting geometry.", + "operationId": "PlantTissueAnalyses_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchPlantTissueAnalysisQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchPlantTissueAnalysisQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PlantTissueAnalysisMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_Search": { + "$ref": "./examples/PlantTissueAnalyses_Search.json" + } + } + } + }, + "/plant-tissue-analyses/cascade-delete/{jobId}": { + "put": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Create a cascade delete job for specified plant tissue analysis.", + "operationId": "PlantTissueAnalyses_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "plantTissueAnalysisId", + "description": "ID of the plant tissue analysis to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PlantTissueAnalyses_CreateCascadeDeleteJob": { + "$ref": "./examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "PlantTissueAnalyses" + ], + "description": "Get a cascade delete job for specified plant tissue analysis.", + "operationId": "PlantTissueAnalyses_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PlantTissueAnalyses_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/parties/{partyId}/prescription-maps": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Returns a paginated list of prescription map resources under a particular party.", + "operationId": "PrescriptionMaps_ListByPartyId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "types", + "description": "Types of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Crop Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Field Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources for the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMapListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrescriptionMaps_ListByPartyId": { + "$ref": "./examples/PrescriptionMaps_ListByPartyId.json" + } + } + } + }, + "/parties/{partyId}/prescription-maps/{prescriptionMapId}": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Gets a specified prescription map resource under a particular party.", + "operationId": "PrescriptionMaps_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionMapId", + "description": "Id of the prescription map.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_Get": { + "$ref": "./examples/PrescriptionMaps_Get.json" + } + } + }, + "patch": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Creates or Updates a prescription map resource under a particular party.", + "operationId": "PrescriptionMaps_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionMapId", + "description": "Id of the prescription map resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "prescriptionMap", + "description": "PrescriptionMap resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_CreateOrUpdate": { + "$ref": "./examples/PrescriptionMaps_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Deletes a specified prescription map resource under a particular party.", + "operationId": "PrescriptionMaps_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionMapId", + "description": "Id of the prescriptionMap.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_Delete": { + "$ref": "./examples/PrescriptionMaps_Delete.json" + } + } + } + }, + "/prescription-maps": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Returns a paginated list of prescription map resources across all parties.", + "operationId": "PrescriptionMaps_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "types", + "description": "Types of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "cropIds", + "description": "Crop Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "seasonIds", + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "fieldIds", + "description": "Field Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sources", + "description": "Sources for the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMapListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrescriptionMaps_List": { + "$ref": "./examples/PrescriptionMaps_List.json" + } + } + } + }, + "/prescription-maps/cascade-delete/{jobId}": { + "get": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Get a cascade delete job for specified prescription map.", + "operationId": "PrescriptionMaps_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "PrescriptionMaps_GetCascadeDeleteJobDetails": { + "$ref": "./examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "PrescriptionMaps" + ], + "description": "Create a cascade delete job for specified prescription map.", + "operationId": "PrescriptionMaps_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "prescriptionMapId", + "description": "ID of the prescription map to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "PrescriptionMaps_CreateCascadeDeleteJob": { + "$ref": "./examples/PrescriptionMaps_CreateCascadeDeleteJob.json" + } + } + } + }, + "/parties/{partyId}/prescriptions/{prescriptionId}": { + "get": { + "tags": [ + "Prescriptions" + ], + "description": "Gets a specified prescription resource under a particular party.", + "operationId": "Prescriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionId", + "description": "Id of the prescription.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Prescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_Get": { + "$ref": "./examples/Prescriptions_Get.json" + } + } + }, + "patch": { + "tags": [ + "Prescriptions" + ], + "description": "Creates or Updates a prescription resource under a particular party.", + "operationId": "Prescriptions_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionId", + "description": "Id of the prescription resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "prescription", + "description": "Prescription resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Prescription" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Prescription" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Prescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_CreateOrUpdate": { + "$ref": "./examples/Prescriptions_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Prescriptions" + ], + "description": "Deletes a specified prescription resource under a particular party.", + "operationId": "Prescriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "prescriptionId", + "description": "Id of the prescription.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_Delete": { + "$ref": "./examples/Prescriptions_Delete.json" + } + } + } + }, + "/prescription:search": { + "post": { + "tags": [ + "Prescriptions" + ], + "description": "Search for Prescriptions across all parties by intersecting geometry.", + "operationId": "Prescriptions_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchPrescriptionQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchPrescriptionQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrescriptionMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_Search": { + "$ref": "./examples/Prescriptions_Search.json" + } + } + } + }, + "/prescriptions/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Prescriptions" + ], + "description": "Get a cascade delete job for specified prescription.", + "operationId": "Prescriptions_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Prescriptions_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Prescriptions_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Prescriptions" + ], + "description": "Create a cascade delete job for specified prescription.", + "operationId": "Prescriptions_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "prescriptionId", + "description": "ID of the prescription to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prescriptions_CreateCascadeDeleteJob": { + "$ref": "./examples/Prescriptions_CreateCascadeDeleteJob.json" + } + } + } + }, + "/scenes": { + "get": { + "tags": [ + "Scenes" + ], + "description": "Returns a paginated list of scene resources.", + "operationId": "Scenes_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "provider", + "description": "Provider name of scene data. Supported value: SentinelHub.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "PartyId.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "associatedResourceId", + "description": "Associated Resource Id of the resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "associatedResourceType", + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "collection", + "description": "Collection name of scene data, Available Values: sentinel-2-l2a, sentinel-2l1c.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "itemId", + "description": "Item Id.", + "type": "string" + }, + { + "in": "query", + "name": "startDateTime", + "description": "Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "endDateTime", + "description": "Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCloudCoveragePercentage", + "description": "Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0].", + "type": "number", + "format": "double", + "default": 100, + "maximum": 100, + "minimum": 0 + }, + { + "in": "query", + "name": "maxDarkPixelCoveragePercentage", + "description": "Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0].", + "type": "number", + "format": "double", + "default": 100, + "maximum": 100, + "minimum": 0 + }, + { + "in": "query", + "name": "imageNames", + "description": "List of image names to be filtered.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "imageResolutions", + "description": "List of image resolutions in meters to be filtered.", + "type": "array", + "items": { + "format": "double", + "type": "number" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "imageFormats", + "description": "List of image formats to be filtered.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SceneListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Scenes_List": { + "$ref": "./examples/Scenes_List.json" + } + } + } + }, + "/scenes/downloadFiles": { + "get": { + "tags": [ + "Scenes" + ], + "description": "Downloads and returns file Stream as response for the given input filePath.", + "operationId": "Scenes_Download", + "produces": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "in": "query", + "name": "filePath", + "description": "cloud storage path of scene file.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "format": "binary", + "type": "file" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Scenes_Download": { + "$ref": "./examples/Scenes_Download.json" + } + } + } + }, + "/scenes/satellite/ingest-data/{jobId}": { + "put": { + "tags": [ + "Scenes" + ], + "description": "Create a satellite data ingestion job.", + "operationId": "Scenes_CreateSatelliteDataIngestionJob", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "JobId provided by user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "job", + "description": "Job parameters supplied by user.", + "required": true, + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Scenes_CreateSatelliteDataIngestionJob": { + "$ref": "./examples/Scenes_CreateSatelliteDataIngestionJob.json" + } + } + }, + "get": { + "tags": [ + "Scenes" + ], + "description": "Get a satellite data ingestion job.", + "operationId": "Scenes_GetSatelliteDataIngestionJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SatelliteDataIngestionJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Scenes_GetSatelliteDataIngestionJobDetails": { + "$ref": "./examples/Scenes_GetSatelliteDataIngestionJobDetails.json" + } + } + } + }, + "/scenes/stac-collections/{collectionId}:search": { + "post": { + "tags": [ + "Scenes" + ], + "description": "Search for STAC items by collection id, bbox, intersecting geometry, start and end datetime.", + "operationId": "Scenes_SearchItems", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "collectionId", + "description": "Collection Id to be searched. Available Values are: sentinel-2-l2a, sentinel-2-l1c.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "maxpagesize", + "description": "Maximum number of items needed (inclusive). Minimum = 1, Maximum = 100, Default value = 10.", + "type": "integer", + "format": "int32", + "default": 10, + "maximum": 100, + "minimum": 1 + }, + { + "in": "query", + "name": "skip", + "description": "Skip token for getting next set of results.", + "type": "integer", + "format": "int32", + "maximum": 2147483647, + "minimum": 1 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchItemsQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchItemsQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SearchItemsResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Scenes_SearchItems": { + "$ref": "./examples/Scenes_SearchItems.json" + } + } + } + }, + "/parties/{partyId}/seasonal-fields/{seasonalFieldId}": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Gets a specified seasonal field resource under a particular party.", + "operationId": "SeasonalFields_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Id of the seasonal field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_Get": { + "$ref": "./examples/SeasonalFields_Get.json" + } + } + }, + "patch": { + "tags": [ + "SeasonalFields" + ], + "description": "Creates or Updates a seasonal field resource under a particular party.", + "operationId": "SeasonalFields_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Id of the seasonal field resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "seasonalField", + "description": "Seasonal field resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/SeasonalField" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalField" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_CreateOrUpdate": { + "$ref": "./examples/SeasonalFields_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SeasonalFields" + ], + "description": "Deletes a specified seasonal-field resource under a particular party.", + "operationId": "SeasonalFields_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "seasonalFieldId", + "description": "Id of the seasonal field.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_Delete": { + "$ref": "./examples/SeasonalFields_Delete.json" + } + } + } + }, + "/seasonal-fields:search": { + "post": { + "tags": [ + "SeasonalFields" + ], + "description": "Search for SeasonalFields across all parties by intersecting geometry.", + "operationId": "SeasonalFields_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchSeasonalFieldQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchSeasonalFieldQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonalFieldMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_Search": { + "$ref": "./examples/SeasonalFields_Search.json" + } + } + } + }, + "/seasonal-fields/cascade-delete/{jobId}": { + "get": { + "tags": [ + "SeasonalFields" + ], + "description": "Get cascade delete job for specified seasonal field.", + "operationId": "SeasonalFields_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SeasonalFields_GetCascadeDeleteJobDetails": { + "$ref": "./examples/SeasonalFields_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "SeasonalFields" + ], + "description": "Create a cascade delete job for specified seasonal field.", + "operationId": "SeasonalFields_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "seasonalFieldId", + "description": "ID of the seasonalField to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SeasonalFields_CreateCascadeDeleteJob": { + "$ref": "./examples/SeasonalFields_CreateCascadeDeleteJob.json" + } + } + } + }, + "/seasons": { + "get": { + "tags": [ + "Seasons" + ], + "description": "Returns a paginated list of season resources.", + "operationId": "Seasons_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "minStartDateTime", + "description": "Minimum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxStartDateTime", + "description": "Maximum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minEndDateTime", + "description": "Minimum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxEndDateTime", + "description": "Maximum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "years", + "description": "Years of the resource.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SeasonListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Seasons_List": { + "$ref": "./examples/Seasons_List.json" + } + } + } + }, + "/seasons/{seasonId}": { + "get": { + "tags": [ + "Seasons" + ], + "description": "Gets a specified season resource.", + "operationId": "Seasons_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "seasonId", + "description": "Id of the season.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Seasons_Get": { + "$ref": "./examples/Seasons_Get.json" + } + } + }, + "patch": { + "tags": [ + "Seasons" + ], + "description": "Creates or updates a season resource.", + "operationId": "Seasons_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "seasonId", + "description": "Id of the season resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "season", + "description": "Season resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Season" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Season" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Seasons_CreateOrUpdate": { + "$ref": "./examples/Seasons_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Seasons" + ], + "description": "Deletes a specified season resource.", + "operationId": "Seasons_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "seasonId", + "description": "Id of the season.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Seasons_Delete": { + "$ref": "./examples/Seasons_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensor-data-models": { + "get": { + "tags": [ + "SensorDataModels" + ], + "description": "Returns a paginated list of sensor data model resources.", + "operationId": "SensorDataModels_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorDataModelListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SensorDataModels_List": { + "$ref": "./examples/SensorDataModels_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}": { + "patch": { + "tags": [ + "SensorDataModels" + ], + "description": "Create a sensor data model entity.", + "operationId": "SensorDataModels_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorDataModelId", + "description": "Id of the sensor data model.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorDataModelObject", + "description": "Sensor data model object details.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorDataModels_CreateOrUpdate": { + "$ref": "./examples/SensorDataModels_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SensorDataModels" + ], + "description": "Gets a sensor data model entity.", + "operationId": "SensorDataModels_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorDataModelId", + "description": "Id of the sensor data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorDataModels_Get": { + "$ref": "./examples/SensorDataModels_Get.json" + } + } + }, + "delete": { + "tags": [ + "SensorDataModels" + ], + "description": "Deletes a sensor data model entity.", + "operationId": "SensorDataModels_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorDataModelId", + "description": "Id of the sensor data model resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorDataModels_Delete": { + "$ref": "./examples/SensorDataModels_Delete.json" + } + } + } + }, + "/sensor-events": { + "get": { + "tags": [ + "SensorEvents" + ], + "description": "Returns a list of sensor events data. Time span for query is limited to 90 days at a time.\r\nReturns last 90 days events when startDateTime and endDateTime are not provided.", + "operationId": "SensorEvents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "sensorId", + "description": "Id of the associated sensor.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "startDateTime", + "description": "Search span start time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nIt is truncated upto seconds if fraction is provided.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "endDateTime", + "description": "Search span end time of sensor events (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nIt is truncated upto seconds if fraction is provided.", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "excludeDuplicateEvents", + "description": "Flag to exclude duplicate events and take the latest ones only (Default: false).", + "type": "boolean", + "default": false + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorEventListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorEvents_List": { + "$ref": "./examples/SensorEvents_List.json" + } + } + } + }, + "/sensor-mappings": { + "get": { + "tags": [ + "SensorMappings" + ], + "description": "Returns a paginated list of sensor mapping resources.", + "operationId": "SensorMappings_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "sensorIds", + "description": "Id of the sensors.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sensorPartnerIds", + "description": "Id of the sensor partners.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "partyIds", + "description": "Id of the parties.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedResourceIds", + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "associatedResourceType", + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, FarmOperationApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorMappingListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SensorMappings_List": { + "$ref": "./examples/SensorMappings_List.json" + } + } + } + }, + "/sensor-mappings/{sensorMappingId}": { + "patch": { + "tags": [ + "SensorMappings" + ], + "description": "Create a sensor mapping entity.", + "operationId": "SensorMappings_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorMappingId", + "description": "Id of the sensor mapping.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorMappingObject", + "description": "Sensor mapping object details.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorMapping" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SensorMapping" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorMapping" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorMappings_CreateOrUpdate": { + "$ref": "./examples/SensorMappings_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SensorMappings" + ], + "description": "Gets a sensor mapping entity.", + "operationId": "SensorMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorMappingId", + "description": "Id of the sensor mapping resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorMapping" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorMappings_Get": { + "$ref": "./examples/SensorMappings_Get.json" + } + } + }, + "delete": { + "tags": [ + "SensorMappings" + ], + "description": "Deletes a sensor mapping entity.", + "operationId": "SensorMappings_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorMappingId", + "description": "Id of the sensor mapping resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorMappings_Delete": { + "$ref": "./examples/SensorMappings_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations": { + "get": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Gets partner integration models.", + "operationId": "SensorPartnerIntegrations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyIds", + "description": "Ids of the parties.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModelListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SensorPartnerIntegrations_List": { + "$ref": "./examples/SensorPartnerIntegrations_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations/{integrationId}": { + "patch": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Create or update an integration with a sensor partner.", + "operationId": "SensorPartnerIntegrations_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration to be created.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorPartnerIntegrationModel", + "description": "Partner integration model.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_CreateOrUpdate": { + "$ref": "./examples/SensorPartnerIntegrations_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Gets a partner integration model entity.", + "operationId": "SensorPartnerIntegrations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration object.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_Get": { + "$ref": "./examples/SensorPartnerIntegrations_Get.json" + } + } + }, + "delete": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Deletes a partner integration model entity.", + "operationId": "SensorPartnerIntegrations_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_Delete": { + "$ref": "./examples/SensorPartnerIntegrations_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:check-consent": { + "post": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Checks consent for partner integration.", + "operationId": "SensorPartnerIntegrations_CheckConsent", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration object.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "key", + "description": "Partner integration key.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationCheckConsentResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_CheckConsent": { + "$ref": "./examples/SensorPartnerIntegrations_CheckConsent.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/integrations/{integrationId}/:generate-consent-link": { + "post": { + "tags": [ + "SensorPartnerIntegrations" + ], + "description": "Generates partner integration consent link.", + "operationId": "SensorPartnerIntegrations_GenerateConsentLink", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "integrationId", + "description": "Id of the integration object.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorPartnerIntegrationGenerateConsentLinkResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SensorPartnerIntegrations_GenerateConsentLink": { + "$ref": "./examples/SensorPartnerIntegrations_GenerateConsentLink.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors": { + "get": { + "tags": [ + "Sensors" + ], + "description": "Returns a paginated list of sensor resources.", + "operationId": "Sensors_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "sensorDataModelIds", + "description": "Id's of the sensor data models.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "sensorMappingIds", + "description": "Ids of the sensor mappings.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the associated sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "deviceIds", + "description": "Id's of the devices.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "ids", + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "names", + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "propertyFilters", + "description": "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "statuses", + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "in": "query", + "name": "minCreatedDateTime", + "description": "Minimum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxCreatedDateTime", + "description": "Maximum creation date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "minLastModifiedDateTime", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxLastModifiedDateTime", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string", + "format": "date-time" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SensorListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Sensors_List": { + "$ref": "./examples/Sensors_List.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors/{sensorId}": { + "patch": { + "tags": [ + "Sensors" + ], + "description": "Create a sensor entity.", + "operationId": "Sensors_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "sensorDetails", + "description": "Sensor object details.", + "required": true, + "schema": { + "$ref": "#/definitions/Sensor" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Sensor" + } + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Sensor" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_CreateOrUpdate": { + "$ref": "./examples/Sensors_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Sensors" + ], + "description": "Gets a sensor entity.", + "operationId": "Sensors_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Sensor" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_Get": { + "$ref": "./examples/Sensors_Get.json" + } + } + }, + "delete": { + "tags": [ + "Sensors" + ], + "description": "Deletes a sensor entity.", + "operationId": "Sensors_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_Delete": { + "$ref": "./examples/Sensors_Delete.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings": { + "get": { + "tags": [ + "Sensors" + ], + "description": "Gets a sensor connection string.", + "operationId": "Sensors_GetConnectionString", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IoTHubDeviceAuthentication" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_GetConnectionString": { + "$ref": "./examples/Sensors_GetConnectionString.json" + } + } + } + }, + "/sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings/:renew": { + "post": { + "tags": [ + "Sensors" + ], + "description": "Renews a sensor connection string.", + "operationId": "Sensors_RenewConnectionString", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "sensorPartnerId", + "description": "Id of the sensor partner.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "sensorId", + "description": "Id of the sensor resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "renewConnectionStringModel", + "description": "Sensor's connection string model.", + "required": true, + "schema": { + "$ref": "#/definitions/SensorRenewConnectionStringModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IoTHubDeviceAuthentication" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Sensors_RenewConnectionString": { + "$ref": "./examples/Sensors_RenewConnectionString.json" + } + } + } + }, + "/solutions/{solutionId}:cancel": { + "post": { + "tags": [ + "SolutionInference" + ], + "description": "Cancels a job for given solution id.", + "operationId": "SolutionInference_Cancel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "solutionId", + "description": "Id of solution for which job is to be cancelled.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z0-9]{3,100}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "solutionInferenceRequest", + "description": "solutionInferenceRequest containing input needed for job request processing.", + "required": true, + "schema": { + "$ref": "#/definitions/SolutionInference" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object", + "additionalProperties": {} + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SolutionInference_Cancel": { + "$ref": "./examples/SolutionInference_Cancel.json" + } + } + } + }, + "/solutions/{solutionId}:create": { + "post": { + "tags": [ + "SolutionInference" + ], + "description": "Creates a job trigger for a solution.", + "operationId": "SolutionInference_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "solutionId", + "description": "Id of the solution resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z0-9]{3,100}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "solutionInferenceRequest", + "description": "solutionInferenceRequest containing input needed for job request processing.", + "required": true, + "schema": { + "$ref": "#/definitions/SolutionInference" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "type": "object", + "additionalProperties": {} + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SolutionInference_CreateOrUpdate": { + "$ref": "./examples/SolutionInference_CreateOrUpdate.json" + } + } + } + }, + "/solutions/{solutionId}:fetch": { + "post": { + "tags": [ + "SolutionInference" + ], + "description": "Fetches details of triggered job for a solution.", + "operationId": "SolutionInference_Fetch", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "solutionId", + "description": "Id of the solution.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{3,50}[.][a-zA-Z0-9]{3,100}$" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "solutionInferenceRequest", + "description": "solutionInferenceRequest containing input needed for job request processing.", + "required": true, + "schema": { + "$ref": "#/definitions/SolutionInference" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object", + "additionalProperties": {} + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "SolutionInference_Fetch": { + "$ref": "./examples/SolutionInference_Fetch.json" + } + } + } + }, + "/parties/{partyId}/tillage-data/{tillageDataId}": { + "get": { + "tags": [ + "TillageData" + ], + "description": "Get a specified tillage data resource under a particular party.", + "operationId": "TillageData_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tillageDataId", + "description": "ID of the tillage data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageData" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_Get": { + "$ref": "./examples/TillageData_Get.json" + } + } + }, + "patch": { + "tags": [ + "TillageData" + ], + "description": "Creates or updates an tillage data resource under a particular party.", + "operationId": "TillageData_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tillageDataId", + "description": "ID of the tillage data resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "tillageData", + "description": "Tillage data resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/TillageData" + } + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + }, + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageData" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/TillageData" + } + } + }, + "x-ms-examples": { + "TillageData_CreateOrUpdate": { + "$ref": "./examples/TillageData_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "TillageData" + ], + "description": "Deletes a specified tillage data resource under a particular party.", + "operationId": "TillageData_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "ID of the associated party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "tillageDataId", + "description": "ID of the tillage data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_Delete": { + "$ref": "./examples/TillageData_Delete.json" + } + } + } + }, + "/tillage-data:search": { + "post": { + "tags": [ + "TillageData" + ], + "description": "Search for TillageData across all parties by intersecting geometry.", + "operationId": "TillageData_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchFarmOperationQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchTillageDataQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/TillageDataMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_Search": { + "$ref": "./examples/TillageData_Search.json" + } + } + } + }, + "/tillage-data/cascade-delete/{jobId}": { + "put": { + "tags": [ + "TillageData" + ], + "description": "Create cascade delete job for tillage data resource.", + "operationId": "TillageData_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job Id supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "tillageDataId", + "description": "Id of the tillage data.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "TillageData_CreateCascadeDeleteJob": { + "$ref": "./examples/TillageData_CreateCascadeDeleteJob.json" + } + } + }, + "get": { + "tags": [ + "TillageData" + ], + "description": "Get cascade delete job for tillage data resource.", + "operationId": "TillageData_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "TillageData_GetCascadeDeleteJobDetails": { + "$ref": "./examples/TillageData_GetCascadeDeleteJobDetails.json" + } + } + } + }, + "/weather-data:fetch": { + "post": { + "tags": [ + "WeatherData" + ], + "description": "Returns a list of WeatherData.", + "operationId": "WeatherData_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "weatherDataProviderRequest", + "description": "Weather data provider request.", + "required": true, + "schema": { + "$ref": "#/definitions/WeatherDataProviderRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/WeatherDataProviderResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "WeatherData_Get": { + "$ref": "./examples/WeatherData_Get.json" + } + } + } + }, + "/parties/{partyId}/zones/{zoneId}": { + "get": { + "tags": [ + "Zones" + ], + "description": "Gets a specified zone resource under a particular party.", + "operationId": "Zones_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "zoneId", + "description": "Id of the zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Zone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_Get": { + "$ref": "./examples/Zones_Get.json" + } + } + }, + "patch": { + "tags": [ + "Zones" + ], + "description": "Creates or updates a Zone resource.", + "operationId": "Zones_CreateOrUpdate", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party resource.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "zoneId", + "description": "Id of the zone resource.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "zone", + "description": "Zone resource payload to create or update.", + "required": true, + "schema": { + "$ref": "#/definitions/Zone" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Zone" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Zone" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_CreateOrUpdate": { + "$ref": "./examples/Zones_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Zones" + ], + "description": "Deletes a specified zone resource under a particular party.", + "operationId": "Zones_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "partyId", + "description": "Id of the party.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "zoneId", + "description": "Id of the zone.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_Delete": { + "$ref": "./examples/Zones_Delete.json" + } + } + } + }, + "/zone:search": { + "post": { + "tags": [ + "Zones" + ], + "description": "Search for Zones across all parties by intersecting geometry.", + "operationId": "Zones_Search", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "searchZoneQuery", + "description": "Query filters.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchZoneQuery" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ZoneMetaDataListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_Search": { + "$ref": "./examples/Zones_Search.json" + } + } + } + }, + "/zones/cascade-delete/{jobId}": { + "get": { + "tags": [ + "Zones" + ], + "description": "Get a cascade delete job for specified job id.", + "operationId": "Zones_GetCascadeDeleteJobDetails", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Id of the job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Zones_GetCascadeDeleteJobDetails": { + "$ref": "./examples/Zones_GetCascadeDeleteJobDetails.json" + } + } + }, + "put": { + "tags": [ + "Zones" + ], + "description": "Create a cascade delete job for specified zone.", + "operationId": "Zones_CreateCascadeDeleteJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "Job ID supplied by end user.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "partyId", + "description": "ID of the associated party.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "zoneId", + "description": "ID of the zone to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "description": "The requested API version", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/CascadeDeleteJob" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "x-ms-client-name": "ErrorCode" + } + }, + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Zones_CreateCascadeDeleteJob": { + "$ref": "./examples/Zones_CreateCascadeDeleteJob.json" + } + } + } + } + }, + "definitions": { + "AdditionalProviderParameters": { + "description": "Schema of additional parameters for weather data provider request.", + "type": "object", + "properties": { + "iconResolution": { + "description": "Icon Resolution (Only applicable for AzureWeatherMaps).", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "details": { + "description": "Details (Only applicable for AzureWeatherMaps).", + "default": true, + "type": "boolean" + } + } + }, + "ApiKeyAuthCredentials": { + "description": "Api Key Auth Credentials class for API Key based Auth.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthCredentials" + }, + { + "required": [ + "apiKey" + ], + "type": "object", + "properties": { + "apiKey": { + "$ref": "#/definitions/KeyVaultProperties" + } + } + } + ], + "x-ms-discriminator-value": "ApiKeyAuthCredentials" + }, + "ApplicationData": { + "description": "Schema of application data resource.", + "type": "object", + "properties": { + "applicationProductDetails": { + "description": "Application product details.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationProductDetail" + } + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ApplicationDataMetaData": { + "description": "Schema of application data resource.", + "type": "object", + "properties": { + "applicationProductDetails": { + "description": "Application product details.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationProductDetail" + } + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ApplicationDataMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationDataMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "ApplicationProductDetail": { + "description": "Schema of product used during application.", + "type": "object", + "properties": { + "productName": { + "description": "Name of the product applied.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "isCarrier": { + "description": "A flag indicating whether product is a carrier for a tank mix.", + "default": false, + "type": "boolean" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + } + } + }, + "Attachment": { + "description": "Schema of attachment resource.", + "type": "object", + "properties": { + "resourceId": { + "description": "Associated Resource id for this attachment.", + "type": "string" + }, + "resourceType": { + "description": "Associated Resource type for this attachment.", + "enum": [ + "Party", + "Farm", + "Field", + "SeasonalField", + "ApplicationData", + "HarvestData", + "TillageData", + "PlantingData", + "PlantTissueAnalysis", + "Prescription" + ], + "type": "string", + "x-ms-enum": { + "name": "AttachmentResourceType", + "modelAsString": true + } + }, + "originalFileName": { + "description": "Original File Name for this attachment.", + "type": "string", + "readOnly": true + }, + "partyId": { + "description": "PartyId id for this attachment.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date when resource was created.", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date when resource was last modified.", + "type": "string", + "readOnly": true + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + } + } + }, + "AttachmentListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Attachment" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "AuthCredentials": { + "description": "AuthCredentials abstract base class for Auth Purpose.", + "required": [ + "kind" + ], + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/AuthCredentialsKind" + } + }, + "discriminator": "kind" + }, + "AuthCredentialsKind": { + "description": "Enum for different types of AuthCredentials supported.", + "enum": [ + "OAuthClientCredentials", + "ApiKeyAuthCredentials" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthCredentialsKind", + "modelAsString": true + } + }, + "CascadeDeleteJob": { + "description": "Schema of cascade delete job.", + "required": [ + "partyId", + "resourceId", + "resourceType" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "resourceId": { + "description": "The id of the resource.", + "minLength": 1, + "type": "string" + }, + "resourceType": { + "description": "The type of the resource.", + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "enum": [ + "Waiting", + "Running", + "Succeeded", + "Failed", + "Cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + } + } + }, + "ChemicalProduct": { + "description": "Schema of ChemicalProduct resource.", + "type": "object", + "properties": { + "cropIds": { + "description": "The Ids of the crops associated with the Chemical product.\r\nNote: A maximum of 25 crops can be associated with a cropProduct.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "reference": { + "$ref": "#/definitions/Reference" + }, + "brand": { + "description": "Commercial brand of the chemical product.", + "type": "string" + }, + "product": { + "description": "Commercial product name of the chemical product.", + "type": "string" + }, + "type": { + "description": "Herbicide, Additive, Insecticides, Fertilizers.", + "type": "string" + }, + "state": { + "description": "Liquid/non Liquid.", + "type": "string" + }, + "activeIngredients": { + "description": "Active chemicals in the formulation.", + "type": "array", + "items": { + "type": "string" + } + }, + "specificGravity": { + "description": "Specific gravity details.", + "type": "string" + }, + "formulation": { + "description": "Formulation description. Percentage or other unit of N, P, K, CA, MG, S, FE, MN, ZN, CU, B, MO, CL\r\n(based on the source, the available chemical elements can vary, but this is a typical list).", + "type": "string" + }, + "company": { + "$ref": "#/definitions/Company" + }, + "location": { + "description": "Area where the chemical is used. This is important from a compliance perspective.", + "type": "string" + }, + "registrationNumber": { + "description": "Registration number of the chemical. This could vary by geography.", + "type": "string" + }, + "reEntryInterval": { + "format": "int32", + "description": "The number of days after which a person can visit the field after the chemical product is applied.", + "type": "integer" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ChemicalProductListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ChemicalProduct" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Company": { + "description": "Company/Manufacturer's details.", + "type": "object", + "properties": { + "name": { + "description": "Name of the manufacturing company.", + "type": "string" + }, + "description": { + "description": "Manufacturing Company description.", + "type": "string" + }, + "registrationNumber": { + "description": "Registration number of the company.", + "type": "string" + } + } + }, + "Crop": { + "description": "Schema of crop resource.", + "type": "object", + "properties": { + "reference": { + "$ref": "#/definitions/Reference" + }, + "phenotype": { + "description": "Phenotype of the crop. Example values are crop weight, height, color, etc.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "breedingMethod": { + "description": "Type of breeding Method like VARIETY, HYBRID, UNKNOWN.", + "type": "string" + }, + "measurements": { + "description": "The properties that pertain to this crop such as nominal weight, nominal moisture, and shrink factor.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + } + }, + "location": { + "description": "Region where the crop is planted.", + "maxLength": 50, + "minLength": 0, + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "CropListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Crop" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "CropProduct": { + "description": "Schema of crop product resource.", + "type": "object", + "properties": { + "cropIds": { + "description": "The IDs of the crops associated with the Chemical product.\r\nNote: A maximum of 25 crops can be associated with a cropProduct.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "reference": { + "$ref": "#/definitions/Reference" + }, + "brand": { + "description": "Commercial brand of the crop product.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "Commercial product name of the crop product.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "relativeMaturity": { + "$ref": "#/definitions/RelativeMaturityMeasure" + }, + "treatments": { + "description": "Seed Coatings Applied for fungus, insects etc.", + "type": "array", + "items": { + "type": "string" + } + }, + "traitStack": { + "description": "Phenotypic expressions like CONV, RR2. These are the Phenotypic expressions like CONV (Conventional), RR2 (RoundUpReady).", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "traits": { + "description": "Traits that are in the stack.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "location": { + "description": "Trait.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "company": { + "$ref": "#/definitions/Company" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "CropProductListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CropProduct" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Dataset": { + "description": "Schema of dataset resource.", + "type": "object", + "properties": { + "type": { + "description": "Type of the dataset. Supported types: Crop, CropProduct, ChemicalProduct, Equipment.", + "enum": [ + "Crop", + "CropProduct", + "ChemicalProduct", + "FarmEquipment" + ], + "type": "string", + "x-ms-enum": { + "name": "DatasetType", + "modelAsString": true + } + }, + "recordsSchema": { + "description": "Schema for records under the dataset.", + "type": "object", + "additionalProperties": {} + }, + "solutionId": { + "description": "Solution id of the dataset solution.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "DatasetAccess": { + "description": "DatasetAccess object.", + "type": "object", + "properties": { + "subscriptionId": { + "description": "Subscription Id.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "resourceId": { + "description": "Azure Data Manager for Agriculture resource Id.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + } + } + }, + "DatasetAccessListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetAccess" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "DatasetListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Dataset" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "DatasetRecord": { + "description": "Schema of dataset records.", + "type": "object", + "properties": { + "datasetId": { + "description": "Dataset Id for this record.", + "type": "string", + "readOnly": true + }, + "record": { + "description": "Record object.", + "type": "object", + "additionalProperties": {} + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "DatasetRecordListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetRecord" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Device": { + "description": "Device API model.", + "type": "object", + "properties": { + "deviceDataModelId": { + "description": "Id of the associated device data model.", + "type": "string" + }, + "integrationId": { + "description": "Integration id for the device.", + "type": "string" + }, + "type": { + "description": "Type of device.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "hardwareId": { + "description": "Device hardwareId.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "reportingIntervalInSeconds": { + "format": "int32", + "description": "Interval at which the device sends data in seconds.", + "type": "integer" + }, + "parentDeviceId": { + "description": "Parent device Id for this device.", + "type": "string" + }, + "location": { + "$ref": "#/definitions/Location" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "DeviceDataModel": { + "description": "DeviceDataModel API model.", + "type": "object", + "properties": { + "type": { + "description": "Type of device.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "manufacturer": { + "description": "Device manufacturer.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productCode": { + "description": "Device productCode.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "ports": { + "description": "List of device ports supported.", + "type": "array", + "items": { + "$ref": "#/definitions/Port" + } + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "DeviceDataModelListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/DeviceDataModel" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "DeviceListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Device" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Error": { + "description": "An error from the Azure AgPlatform service.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "Server-defined set of error codes.", + "minLength": 1, + "type": "string" + }, + "message": { + "description": "Human-readable representation of the error.", + "minLength": 1, + "type": "string" + }, + "target": { + "description": "Target of the error.", + "type": "string" + }, + "details": { + "description": "Array of details about specific errors that led to this reported error.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorForLocation": { + "description": "Model for error information for a failed location.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/WeatherLocation" + }, + "code": { + "format": "int32", + "description": "Status code returned by data provider.", + "type": "integer" + }, + "description": { + "description": "Description of the error.", + "type": "string" + }, + "retryable": { + "description": "Flag suggesting if retry attempt with same request body should be made to fetch required data.", + "type": "boolean" + } + } + }, + "ErrorResponse": { + "description": "An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + }, + "traceId": { + "description": "Unique trace Id.", + "type": "string" + } + } + }, + "Farm": { + "description": "Schema of farm resource.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmEquipment": { + "description": "Schema of FarmEquipment resource.", + "type": "object", + "properties": { + "cropIds": { + "description": "The IDs of the crops associated with the Chemical product.\r\nNote: A maximum of 25 crops can be associated with a cropProduct.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "reference": { + "$ref": "#/definitions/Reference" + }, + "brand": { + "description": "Commercial brand of the chemical product.", + "type": "string" + }, + "series": { + "description": "Series number of the Farm Equipment.", + "type": "string" + }, + "model": { + "description": "Model number of the Farm Equipment.", + "type": "string" + }, + "serial": { + "description": "Serial number of the Farm Equipment.", + "type": "string" + }, + "type": { + "description": "Type of the Farm Equipment (Tiller, Sower, harvester, Sprayer, …).", + "type": "string" + }, + "ownership": { + "description": "Owned, rented, shared, etc.", + "type": "string" + }, + "location": { + "description": "Area where the equipment is used.", + "type": "string" + }, + "company": { + "$ref": "#/definitions/Company" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmEquipmentListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/FarmEquipment" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "FarmListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Farm" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "FarmOperationDataIngestionJob": { + "description": "Schema of farm operation data ingestion job.", + "required": [ + "authProviderId", + "partyId", + "providerInput", + "startYear" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "authProviderId": { + "description": "Authentication provider Id.", + "minLength": 1, + "type": "string" + }, + "operations": { + "description": "List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage.", + "type": "array", + "items": { + "type": "string" + } + }, + "startYear": { + "format": "int32", + "description": "Start Year (Minimum = 2000, Maximum = CurrentYear).", + "type": "integer" + }, + "isIncremental": { + "description": "Use this to pull only the incremental changes from the last run.", + "default": false, + "type": "boolean" + }, + "providerInput": { + "$ref": "#/definitions/FarmOperationJobProviderInput" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FarmOperationJobProviderInput": { + "description": "Schema for provider input for Farm operations job.", + "required": [ + "shapeResolution", + "shapeType" + ], + "type": "object", + "properties": { + "shapeType": { + "description": "Type of shape file to be ingested from JohnDeere.\r\nPossible values of shape file type are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.", + "minLength": 1, + "enum": [ + "Point", + "Polygon", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ShapeType", + "modelAsString": true + } + }, + "shapeResolution": { + "description": "Resolution of shape file to be ingested from JohnDeere.\r\nPossible values of shape file resolution are taken from - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.", + "minLength": 1, + "enum": [ + "EachSection", + "EachSensor", + "OneHertz", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ShapeResolution", + "modelAsString": true + } + } + } + }, + "Field": { + "description": "Schema of field resource.", + "type": "object", + "properties": { + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FieldMetaData": { + "description": "Schema of field resource.", + "type": "object", + "properties": { + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "FieldMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/FieldMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "GeoJsonObject": { + "description": "GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format.", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonObjectType" + } + }, + "discriminator": "type" + }, + "GeoJsonObjectType": { + "description": "GeoJSON object type.", + "enum": [ + "Point", + "Polygon", + "MultiPolygon" + ], + "type": "string", + "x-ms-enum": { + "name": "GeoJsonObjectType", + "modelAsString": true + } + }, + "GeoResource": { + "description": "Schema for storing resource type and resource id.", + "type": "object", + "properties": { + "type": { + "description": "Resource Type.", + "enum": [ + "Field", + "SeasonalField", + "Zone", + "Prescription", + "PlantTissueAnalysis", + "PlantingData", + "ApplicationData", + "HarvestData", + "TillageData" + ], + "type": "string", + "x-ms-enum": { + "name": "FarmHierarchyGeoResourceType", + "modelAsString": true + } + }, + "id": { + "description": "Resource Id.", + "type": "string" + } + } + }, + "HarvestData": { + "description": "Schema of harvest data resource.", + "type": "object", + "properties": { + "totalYield": { + "$ref": "#/definitions/Measure" + }, + "avgYield": { + "$ref": "#/definitions/Measure" + }, + "totalWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgMoisture": { + "$ref": "#/definitions/Measure" + }, + "avgSpeed": { + "$ref": "#/definitions/Measure" + }, + "harvestProductDetails": { + "description": "Harvest product details.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "HarvestDataMetaData": { + "description": "Schema of harvest data resource.", + "type": "object", + "properties": { + "totalYield": { + "$ref": "#/definitions/Measure" + }, + "avgYield": { + "$ref": "#/definitions/Measure" + }, + "totalWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgMoisture": { + "$ref": "#/definitions/Measure" + }, + "avgSpeed": { + "$ref": "#/definitions/Measure" + }, + "harvestProductDetails": { + "description": "Harvest product details.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "HarvestDataMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/HarvestDataMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "HarvestProductDetail": { + "description": "Schema of product used during harvesting.", + "type": "object", + "properties": { + "productName": { + "description": "Name of the product.", + "maxLength": 100, + "minLength": 1, + "type": "string" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "totalYield": { + "$ref": "#/definitions/Measure" + }, + "avgYield": { + "$ref": "#/definitions/Measure" + }, + "avgMoisture": { + "$ref": "#/definitions/Measure" + }, + "totalWetMass": { + "$ref": "#/definitions/Measure" + }, + "avgWetMass": { + "$ref": "#/definitions/Measure" + } + } + }, + "ImageFile": { + "description": "Schema of image file resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "fileLink": { + "description": "Link of the image file.", + "type": "string" + }, + "name": { + "description": "Name of the image file.", + "minLength": 1, + "type": "string" + }, + "imageFormat": { + "$ref": "#/definitions/ImageFormat" + }, + "resolution": { + "format": "double", + "description": "Resolution of image file in meters.", + "type": "number" + } + } + }, + "ImageFormat": { + "description": "Supported image formats for scene resource.", + "enum": [ + "TIF" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageFormat", + "modelAsString": true + } + }, + "ImageProcessingRasterizeJob": { + "description": "Image Processing Rasterize Job to convert shapefile into tiff file.", + "required": [ + "partyId", + "shapefileAttachmentId", + "shapefileColumnNames" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "shapefileAttachmentId": { + "description": "Shapefile attachment Id.", + "minLength": 1, + "type": "string" + }, + "shapefileColumnNames": { + "description": "List of shapefile column names to create raster attachments.", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "InnerError": { + "description": "Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.", + "type": "object", + "properties": { + "code": { + "description": "Specific error code than was provided by the containing error.", + "type": "string" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "Insight": { + "description": "Schema of insight resource.", + "type": "object", + "properties": { + "partyId": { + "description": "Id of the associated party.", + "type": "string", + "readOnly": true + }, + "modelId": { + "description": "Id of the associated model.", + "type": "string", + "readOnly": true + }, + "resourceType": { + "description": "Resource type associated with the record.", + "enum": [ + "Party", + "Farm", + "Field", + "SeasonalField" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FarmHierarchyResourceType", + "modelAsString": true + } + }, + "resourceId": { + "description": "Id of the associated resource.", + "type": "string", + "readOnly": true + }, + "modelVersion": { + "description": "Version of the associated model.", + "type": "string" + }, + "attachmentsLink": { + "description": "Gets link for attachments.", + "type": "string", + "readOnly": true + }, + "insightStartDateTime": { + "format": "date-time", + "description": "Start date to which the insight is related.", + "type": "string" + }, + "insightEndDateTime": { + "format": "date-time", + "description": "End date to which the insight is related.", + "type": "string" + }, + "measurements": { + "description": "Measures to capture insights results.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + } + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "InsightAttachment": { + "description": "Schema of insight attachment resource.", + "required": [ + "insightId" + ], + "type": "object", + "properties": { + "insightId": { + "description": "InsightID for this InsightAttachment.", + "minLength": 1, + "type": "string" + }, + "modelId": { + "description": "ModelID for this InsightAttachment.", + "type": "string", + "readOnly": true + }, + "resourceType": { + "description": "Associated Resource type for this attachment.", + "enum": [ + "Party", + "Farm", + "Field", + "SeasonalField" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FarmHierarchyResourceType", + "modelAsString": true + } + }, + "resourceId": { + "description": "Associated Resource id for this attachment.", + "type": "string", + "readOnly": true + }, + "originalFileName": { + "description": "Original File Name for this attachment.", + "type": "string", + "readOnly": true + }, + "partyId": { + "description": "PartyId id for this attachment.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date when resource was created.", + "type": "string", + "readOnly": true + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date when resource was last modified.", + "type": "string", + "readOnly": true + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + } + } + }, + "InsightAttachmentListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/InsightAttachment" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "InsightListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Insight" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "IoTHubDeviceAuthentication": { + "description": "Authentication via connection string to IoTHub devices.", + "type": "object", + "properties": { + "primaryDeviceConnectionString": { + "description": "Primary connection string of the ioTHub device.", + "type": "string", + "readOnly": true + }, + "secondaryDeviceConnectionString": { + "description": "Secondary connection string of the ioTHub device.", + "type": "string", + "readOnly": true + } + } + }, + "KeyVaultProperties": { + "description": "Properties of the key vault.", + "required": [ + "keyName", + "keyVaultUri", + "keyVersion" + ], + "type": "object", + "properties": { + "keyVaultUri": { + "description": "Uri of the key vault.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "keyName": { + "description": "Name of Key Vault key.", + "maxLength": 256, + "minLength": 2, + "type": "string" + }, + "keyVersion": { + "description": "Version of Key Vault key.", + "maxLength": 256, + "minLength": 2, + "type": "string" + } + } + }, + "LabDetails": { + "description": "Model for representing LabDetails object.", + "type": "object", + "properties": { + "code": { + "description": "Code of the resource.", + "maxLength": 150, + "minLength": 0, + "type": "string" + }, + "name": { + "description": "Name of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "address": { + "description": "Address of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + } + } + }, + "Location": { + "description": "Location model class.", + "required": [ + "latitude", + "longitude" + ], + "type": "object", + "properties": { + "latitude": { + "format": "double", + "description": "Latitude of the location.", + "maximum": 90, + "minimum": -90, + "type": "number" + }, + "longitude": { + "format": "double", + "description": "Longitude of the location.", + "maximum": 180, + "minimum": -180, + "type": "number" + } + } + }, + "ManagementZone": { + "description": "Api Model for ManagementZone object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id associated with the ManagementZone.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the ManagementZone.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "seasonId": { + "description": "Season Id associated with the ManagementZone.", + "type": "string" + }, + "cropId": { + "description": "Crop Id associated with the ManagementZone.", + "type": "string" + }, + "fieldId": { + "description": "Field Id associated with the ManagementZone.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ManagementZoneListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagementZone" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Measure": { + "description": "Schema for storing measurement reading and unit.", + "type": "object", + "properties": { + "unit": { + "description": "Data unit.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "value": { + "format": "double", + "description": "Data value.", + "type": "number" + } + } + }, + "Measures": { + "description": "Schema for storing measurement readings and unit.", + "type": "object", + "properties": { + "unit": { + "description": "Data unit.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "value": { + "description": "Data values.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + }, + "MultiPolygon": { + "description": "MultiPolygon geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "required": [ + "coordinates" + ], + "type": "object", + "properties": { + "coordinates": { + "description": "Gets or sets Coordinates of GeoJSON Object.\r\nIt must be an array of polygons, each polygon contains list of linear rings.\r\nFor Polygons with more than one of these rings, the first MUST be the exterior ring,\r\nand any others MUST be interior rings.", + "minItems": 1, + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + } + } + } + ], + "x-ms-discriminator-value": "MultiPolygon" + }, + "NutrientAnalysis": { + "description": "Api Model for nutrient analysis object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party id for this nutrient analysis.", + "type": "string", + "readOnly": true + }, + "parentId": { + "description": "Parent id for this nutrient analysis.", + "type": "string" + }, + "parentType": { + "description": "Parent type for this nutrient analysis.\r\ni.e. PlantTissueAnalysis.", + "enum": [ + "PlantTissueAnalysis" + ], + "type": "string", + "x-ms-enum": { + "name": "NutrientAnalysisParentType", + "modelAsString": true + } + }, + "unit": { + "description": "Unit for this nutrient analysis.", + "maxLength": 32, + "minLength": 0, + "type": "string" + }, + "value": { + "format": "double", + "description": "Value for this nutrient analysis.", + "type": "number" + }, + "referenceValueLow": { + "format": "double", + "description": "Reference value low for this nutrient analysis.", + "type": "number" + }, + "referenceValueHigh": { + "format": "double", + "description": "Reference value high for this nutrient analysis.", + "type": "number" + }, + "classification": { + "description": "Classification for this nutrient analysis.", + "maxLength": 50, + "minLength": 0, + "type": "string" + }, + "recommendation": { + "description": "Recommendation for this nutrient analysis.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "products": { + "description": "Products for this nutrient analysis.", + "type": "array", + "items": { + "$ref": "#/definitions/ProductDetails" + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "NutrientAnalysisListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/NutrientAnalysis" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "OAuthClientCredentials": { + "description": "OAuthClientCredentials for clientId clientSecret auth.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthCredentials" + }, + { + "required": [ + "clientId", + "clientSecret" + ], + "type": "object", + "properties": { + "clientId": { + "description": "ClientId associated with the provider.", + "minLength": 1, + "type": "string" + }, + "clientSecret": { + "$ref": "#/definitions/KeyVaultProperties" + } + } + } + ], + "x-ms-discriminator-value": "OAuthClientCredentials" + }, + "OAuthConnectRequest": { + "description": "Get OAuth config query parameters.", + "required": [ + "oAuthProviderId", + "partyId", + "userRedirectLink" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Id of the party.", + "minLength": 1, + "type": "string" + }, + "oAuthProviderId": { + "description": "Id of the OAuthProvider.", + "minLength": 1, + "type": "string" + }, + "userRedirectLink": { + "description": "Link to redirect the user to, at the end of the oauth flow.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "userRedirectState": { + "description": "State to provide back when redirecting the user, at the end of the oauth flow.", + "maxLength": 200, + "minLength": 0, + "type": "string" + } + } + }, + "OAuthProvider": { + "description": "Schema of OAuth provider resource.", + "type": "object", + "properties": { + "appId": { + "description": "OAuth App Id for given OAuth Provider.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "appSecret": { + "description": "OAuth App secret for given Provider.\r\nNote: Won't be sent in response.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "apiKey": { + "description": "OAuth Api key for given Provider.\r\nNote: currently Applicable to Climate provider. Won't be sent in response.", + "maxLength": 200, + "minLength": 2, + "type": "string" + }, + "isProductionApp": { + "description": "An optional flag to determine if the App is ready to be used for Production scenarios in the provider side or not. (Default value: false)\r\nNote: Currently applicable for JohnDeere.", + "default": false, + "type": "boolean" + }, + "id": { + "description": "Unique OAuth provider ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "OAuthProviderCascadeDeleteJob": { + "description": "Schema of oauth provider cascade delete job.", + "required": [ + "oauthProviderId" + ], + "type": "object", + "properties": { + "oauthProviderId": { + "description": "The id of the oauth provider.", + "minLength": 1, + "type": "string" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "OAuthProviderListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/OAuthProvider" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "OAuthToken": { + "description": "Schema of OAuth token resource.", + "required": [ + "authProviderId", + "partyId" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party ID for this OAuth config.", + "type": "string" + }, + "authProviderId": { + "description": "ID of the OAuth provider resource containing app information.", + "minLength": 1, + "type": "string" + }, + "isValid": { + "description": "An optional flag indicating whether the token is a valid or expired (Default value: true).", + "default": true, + "type": "boolean" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + } + } + }, + "OAuthTokenListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/OAuthToken" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "OverlapResource": { + "description": "Schema of overlap resource.", + "required": [ + "partyId", + "resourceId", + "resourceType" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id of the resource.", + "minLength": 1, + "type": "string" + }, + "resourceType": { + "description": "Resource type of the resource.", + "minLength": 1, + "type": "string" + }, + "resourceId": { + "description": "Id of the resource.", + "minLength": 1, + "type": "string" + }, + "resourceArea": { + "format": "double", + "description": "Acreage of the resource.", + "type": "number", + "readOnly": true + } + } + }, + "OverlapResourcesQuery": { + "description": "Overlap Resource Query Parameters.", + "type": "object", + "properties": { + "resources": { + "description": "List of resources.", + "maxItems": 2, + "minItems": 2, + "type": "array", + "items": { + "$ref": "#/definitions/OverlapResource" + } + } + } + }, + "Party": { + "description": "Schema of party resource.", + "type": "object", + "properties": { + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PartyListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Party" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "PartyOverlapResponse": { + "description": "Schema of Party Overlap Response.", + "type": "object", + "properties": { + "resources": { + "description": "Resources with area.", + "maxItems": 2, + "minItems": 2, + "type": "array", + "items": { + "$ref": "#/definitions/OverlapResource" + } + }, + "overlappingArea": { + "format": "double", + "description": "Acreage of overlapping area.", + "type": "number" + } + } + }, + "PlantTissueAnalysis": { + "description": "Api Model for plant tissue analysis object.", + "type": "object", + "properties": { + "partyId": { + "description": "Id of the associated Party.", + "type": "string", + "readOnly": true + }, + "fieldId": { + "description": "Id of the associated Field.", + "type": "string" + }, + "cropId": { + "description": "Id of the associated Crop.", + "type": "string" + }, + "cropProductId": { + "description": "Id of the associated Crop product.", + "type": "string" + }, + "seasonId": { + "description": "Id of the associated Season.", + "type": "string" + }, + "plantingDateTime": { + "format": "date-time", + "description": "Planting datetime for this plant tissue analysis.", + "type": "string" + }, + "growthStage": { + "description": "Growth stage for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantPart": { + "description": "Plant part for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantPosition": { + "description": "Plant position for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantAppearance": { + "description": "Plant appearance for this plant tissue analysis.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "sampleCollectionCondition": { + "description": "Sample collection condition for this plant tissue analysis.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "sampleCollectionDateTime": { + "format": "date-time", + "description": "Sample collection dateTime for this plant tissue analysis.", + "type": "string" + }, + "sampleReceivedDateTime": { + "format": "date-time", + "description": "Sample received dateTime.", + "type": "string" + }, + "sampleTestResultDateTime": { + "format": "date-time", + "description": "Sample test result dateTime for this plant tissue analysis.", + "type": "string" + }, + "labDetails": { + "$ref": "#/definitions/LabDetails" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantTissueAnalysisMetaData": { + "description": "Api Model for plant tissue analysis object.", + "type": "object", + "properties": { + "partyId": { + "description": "Id of the associated Party.", + "type": "string", + "readOnly": true + }, + "fieldId": { + "description": "Id of the associated Field.", + "type": "string" + }, + "cropId": { + "description": "Id of the associated Crop.", + "type": "string" + }, + "cropProductId": { + "description": "Id of the associated Crop product.", + "type": "string" + }, + "seasonId": { + "description": "Id of the associated Season.", + "type": "string" + }, + "plantingDateTime": { + "format": "date-time", + "description": "Planting datetime for this plant tissue analysis.", + "type": "string" + }, + "growthStage": { + "description": "Growth stage for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantPart": { + "description": "Plant part for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantPosition": { + "description": "Plant position for this plant tissue analysis.", + "maxLength": 200, + "minLength": 0, + "type": "string" + }, + "plantAppearance": { + "description": "Plant appearance for this plant tissue analysis.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "sampleCollectionCondition": { + "description": "Sample collection condition for this plant tissue analysis.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "sampleCollectionDateTime": { + "format": "date-time", + "description": "Sample collection dateTime for this plant tissue analysis.", + "type": "string" + }, + "sampleReceivedDateTime": { + "format": "date-time", + "description": "Sample received dateTime.", + "type": "string" + }, + "sampleTestResultDateTime": { + "format": "date-time", + "description": "Sample test result dateTime for this plant tissue analysis.", + "type": "string" + }, + "labDetails": { + "$ref": "#/definitions/LabDetails" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantTissueAnalysisMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantTissueAnalysisMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "PlantingData": { + "description": "Schema of planting data resource.", + "type": "object", + "properties": { + "avgPlantingRate": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "plantingProductDetails": { + "description": "Planting product details.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantingDataMetaData": { + "description": "Schema of planting data resource.", + "type": "object", + "properties": { + "avgPlantingRate": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + }, + "plantingProductDetails": { + "description": "Planting product details.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingProductDetail" + } + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PlantingDataMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PlantingDataMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "PlantingProductDetail": { + "description": "Schema for Planting product detail.", + "type": "object", + "properties": { + "productName": { + "description": "Name of the product.", + "type": "string" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "totalMaterial": { + "$ref": "#/definitions/Measure" + }, + "avgMaterial": { + "$ref": "#/definitions/Measure" + } + } + }, + "Point": { + "description": "Point geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "required": [ + "coordinates" + ], + "type": "object", + "properties": { + "coordinates": { + "description": "Gets or sets the coordinate of this point.\r\nIt must be an array of 2 or 3 elements for a 2D or 3D system.", + "maximum": 3, + "minimum": 2, + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + ], + "x-ms-discriminator-value": "Point" + }, + "Polygon": { + "description": "Polygon geometry.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJsonObject" + }, + { + "required": [ + "coordinates" + ], + "type": "object", + "properties": { + "coordinates": { + "description": "Gets or sets type of the GeoJSON Object.\r\nIt must be an array of linear ring coordinate arrays.\r\nFor Polygons with more than one of these rings, the first MUST be the exterior ring,\r\nand any others MUST be interior rings.", + "minItems": 1, + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + } + } + } + ], + "x-ms-discriminator-value": "Polygon" + }, + "Port": { + "description": "Schema for storing port values.", + "type": "object", + "properties": { + "name": { + "description": "Name of the port.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Type of port digital/analog.", + "maxLength": 100, + "minLength": 0, + "type": "string" + } + } + }, + "Prescription": { + "description": "Api Model for Prescription object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "prescriptionMapId": { + "description": "Prescription map Id.", + "type": "string" + }, + "productCode": { + "description": "Product Code.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productName": { + "description": "Product name.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "Prescription type.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "measurements": { + "description": "Measures.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PrescriptionMap": { + "description": "Api Model for Prescription Map object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Prescription map type.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "seasonId": { + "description": "Season Id.", + "type": "string" + }, + "cropId": { + "description": "Crop Id.", + "type": "string" + }, + "fieldId": { + "description": "Field Id.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PrescriptionMapListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PrescriptionMap" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "PrescriptionMetaData": { + "description": "Api Model for Prescription object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "prescriptionMapId": { + "description": "Prescription map Id.", + "type": "string" + }, + "productCode": { + "description": "Product Code.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productName": { + "description": "Product name.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "type": { + "description": "Prescription type.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "measurements": { + "description": "Measures.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Measure" + } + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "PrescriptionMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PrescriptionMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "ProductDetails": { + "description": "Model for representing ProductDetails object.", + "type": "object", + "properties": { + "rate": { + "description": "Rate of the product.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "instruction": { + "description": "Instruction of the resource.", + "maxLength": 1000, + "minLength": 0, + "type": "string" + }, + "product": { + "description": "Product of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + } + } + }, + "Reference": { + "description": "Reference to a dataset record.", + "type": "object", + "properties": { + "datasetId": { + "description": "Dataset id.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "recordId": { + "description": "Record id.", + "maxLength": 100, + "minLength": 0, + "type": "string" + } + } + }, + "RelativeMaturityMeasure": { + "description": "Relative maturity measure.", + "type": "object", + "properties": { + "unit": { + "description": "Data unit.", + "maxLength": 50, + "minLength": 1, + "type": "string" + }, + "value": { + "format": "double", + "description": "Data value.", + "type": "number" + }, + "method": { + "description": "The method used to determine the relative maturity of the product. Examples include\r\nComparative Relative Maturity or Heat Units.", + "maxLength": 50, + "minLength": 1, + "type": "string" + } + } + }, + "SatelliteData": { + "description": "Data Model for SatelliteIngestionJobRequest.", + "type": "object", + "properties": { + "imageNames": { + "description": "List of ImageNames.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NDVI" + ] + }, + "imageFormats": { + "description": "List of ImageFormats. Available value: TIF.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "TIF" + ] + }, + "imageResolutions": { + "description": "List of ImageResolutions in meters. Available values: 10, 20, 60.", + "type": "array", + "items": { + "format": "double", + "type": "number" + }, + "example": [ + 10 + ] + } + } + }, + "SatelliteDataIngestionJob": { + "description": "Schema of satellite data ingestion job.", + "required": [ + "associatedResource", + "collection", + "partyId" + ], + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/OAuthClientCredentials" + }, + "partyId": { + "description": "Party Id.", + "minLength": 1, + "type": "string" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "startDateTime": { + "format": "date-time", + "description": "Start Date.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "End Date.", + "type": "string" + }, + "provider": { + "description": "Provider of satellite data. Available Value: SentinelHub.", + "enum": [ + "SentinelHub" + ], + "type": "string", + "x-ms-enum": { + "name": "SatelliteDataProvider", + "modelAsString": true + } + }, + "collection": { + "description": "Collection of satellite data. Available Value: sentinel-2-l2a, sentinel-2-l1c.", + "minLength": 1, + "type": "string" + }, + "data": { + "$ref": "#/definitions/SatelliteData" + }, + "itemId": { + "description": "Item Id used to get scenes from sentinel hub.", + "type": "string" + }, + "id": { + "description": "Unique job id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the job.\r\nPossible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.", + "type": "string", + "readOnly": true + }, + "durationInSeconds": { + "format": "double", + "description": "Duration of the job in seconds.", + "type": "number", + "readOnly": true + }, + "message": { + "description": "Status message to capture more details of the job.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error Code when job failed.", + "type": "string", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "lastActionDateTime": { + "format": "date-time", + "description": "Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "Scene": { + "description": "Schema of scene resource.", + "type": "object", + "properties": { + "sceneDateTime": { + "format": "date-time", + "description": "Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "provider": { + "description": "Data provider of the scene.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "collection": { + "description": "Data collection of the scene.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "imageFiles": { + "description": "Collection of image files.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageFile" + } + }, + "imageFormat": { + "$ref": "#/definitions/ImageFormat" + }, + "itemId": { + "description": "ItemId to fetch scenes from sentinel hub.", + "type": "string" + }, + "cloudCoverPercentage": { + "format": "double", + "description": "Cloud cover percentage of the scene.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "darkPixelPercentage": { + "format": "double", + "description": "Dark pixel percentage of the scene.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "ndviMedianValue": { + "format": "double", + "description": "Median of NDVI of the scene.", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "partyId": { + "description": "Party ID which belongs to the scene.", + "type": "string" + }, + "id": { + "description": "Unique scene resource ID.", + "type": "string" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + } + } + }, + "SceneListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Scene" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SearchApplicationDataQuery": { + "description": "SearchApplicationDataQuery.", + "type": "object", + "properties": { + "minAvgMaterial": { + "format": "double", + "description": "Minimum average amount of material applied during the application (inclusive).", + "type": "number" + }, + "maxAvgMaterial": { + "format": "double", + "description": "Maximum average amount of material applied during the application (inclusive).", + "type": "number" + }, + "minTotalMaterial": { + "format": "double", + "description": "Minimum total amount of material applied during the application (inclusive).", + "type": "number" + }, + "maxTotalMaterial": { + "format": "double", + "description": "Maximum total amount of material applied during the application (inclusive).", + "type": "number" + }, + "associatedResourceIds": { + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "associatedResourceType": { + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + "minOperationStartDateTime": { + "format": "date-time", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationStartDateTime": { + "format": "date-time", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationEndDateTime": { + "format": "date-time", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationEndDateTime": { + "format": "date-time", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationModifiedDateTime": { + "format": "date-time", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationModifiedDateTime": { + "format": "date-time", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "sources": { + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + } + }, + "minArea": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxArea": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchFieldQuery": { + "description": "SearchAllBoundaries and SearchBoundaries parameters.", + "type": "object", + "properties": { + "farmIds": { + "description": "FarmIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchHarvestDataQuery": { + "description": "SearchHarvestDataQuery.", + "type": "object", + "properties": { + "minTotalYield": { + "format": "double", + "description": "Minimum Yield value(inclusive).", + "type": "number" + }, + "maxTotalYield": { + "format": "double", + "description": "Maximum Yield value (inclusive).", + "type": "number" + }, + "minAvgYield": { + "format": "double", + "description": "Minimum AvgYield value(inclusive).", + "type": "number" + }, + "maxAvgYield": { + "format": "double", + "description": "Maximum AvgYield value (inclusive).", + "type": "number" + }, + "minTotalWetMass": { + "format": "double", + "description": "Minimum Total WetMass value(inclusive).", + "type": "number" + }, + "maxTotalWetMass": { + "format": "double", + "description": "Maximum Total WetMass value (inclusive).", + "type": "number" + }, + "minAvgWetMass": { + "format": "double", + "description": "Minimum AvgWetMass value(inclusive).", + "type": "number" + }, + "maxAvgWetMass": { + "format": "double", + "description": "Maximum AvgWetMass value (inclusive).", + "type": "number" + }, + "minAvgMoisture": { + "format": "double", + "description": "Minimum AvgMoisture value(inclusive).", + "type": "number" + }, + "maxAvgMoisture": { + "format": "double", + "description": "Maximum AvgMoisture value (inclusive).", + "type": "number" + }, + "minAvgSpeed": { + "format": "double", + "description": "Minimum AvgSpeed value(inclusive).", + "type": "number" + }, + "maxAvgSpeed": { + "format": "double", + "description": "Maximum AvgSpeed value (inclusive).", + "type": "number" + }, + "associatedResourceIds": { + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "associatedResourceType": { + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + "minOperationStartDateTime": { + "format": "date-time", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationStartDateTime": { + "format": "date-time", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationEndDateTime": { + "format": "date-time", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationEndDateTime": { + "format": "date-time", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationModifiedDateTime": { + "format": "date-time", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationModifiedDateTime": { + "format": "date-time", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "sources": { + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + } + }, + "minArea": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxArea": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchItemsQuery": { + "description": "Search stac Items parameters.", + "required": [ + "endDateTime", + "startDateTime" + ], + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/OAuthClientCredentials" + }, + "startDateTime": { + "format": "date-time", + "description": "Start datetime of the time interval in which to search for Items.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "End datetime of the time interval in which to search for Items.", + "type": "string" + }, + "intersects": { + "$ref": "#/definitions/GeoJsonObject" + }, + "bbox": { + "description": "Only items that have a geometry that intersects the bounding box are selected.\r\nThe bounding box is provided as four numbers. The coordinate reference system of the values is WGS84 longitude/latitude.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "itemIds": { + "description": "Array of item ids to return.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SearchItemsResponse": { + "description": "Paged response contains list of items and next property to get the next set of results.", + "required": [ + "items" + ], + "type": "object", + "properties": { + "items": { + "description": "List of items.", + "type": "array", + "items": { + "$ref": "#/definitions/StacItem" + } + }, + "nextLink": { + "description": "URL to do the POST request with same filters,\r\nto get next set of items.", + "type": "string", + "readOnly": true + } + } + }, + "SearchPlantTissueAnalysisQuery": { + "description": "Search All PlantTissueAnalysis and Search PlantTissueAnalyses parameters.", + "type": "object", + "properties": { + "fieldIds": { + "description": "Field Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "seasonIds": { + "description": "Season Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "cropProductIds": { + "description": "CropVariety Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "cropIds": { + "description": "CropIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchPlantingDataQuery": { + "description": "SearchPlantingDataQuery.", + "type": "object", + "properties": { + "minAvgPlantingRate": { + "format": "double", + "description": "Minimum AvgPlantingRate value(inclusive).", + "type": "number" + }, + "maxAvgPlantingRate": { + "format": "double", + "description": "Maximum AvgPlantingRate value (inclusive).", + "type": "number" + }, + "minTotalMaterial": { + "format": "double", + "description": "Minimum TotalMaterial value(inclusive).", + "type": "number" + }, + "maxTotalMaterial": { + "format": "double", + "description": "Maximum TotalMaterial value (inclusive).", + "type": "number" + }, + "minAvgMaterial": { + "format": "double", + "description": "Minimum AvgMaterial value(inclusive).", + "type": "number" + }, + "maxAvgMaterial": { + "format": "double", + "description": "Maximum AvgMaterial value (inclusive).", + "type": "number" + }, + "associatedResourceIds": { + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "associatedResourceType": { + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + "minOperationStartDateTime": { + "format": "date-time", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationStartDateTime": { + "format": "date-time", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationEndDateTime": { + "format": "date-time", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationEndDateTime": { + "format": "date-time", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationModifiedDateTime": { + "format": "date-time", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationModifiedDateTime": { + "format": "date-time", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "sources": { + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + } + }, + "minArea": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxArea": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchPrescriptionQuery": { + "description": "Get Zones query parameters.", + "type": "object", + "properties": { + "prescriptionMapIds": { + "description": "Prescription Map Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "types": { + "description": "Types of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "productCodes": { + "description": "Product Codes of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "productNames": { + "description": "Product Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "sources": { + "description": "Sources of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchSeasonalFieldQuery": { + "description": "SearchAllBoundaries and SearchBoundaries parameters.", + "type": "object", + "properties": { + "farmIds": { + "description": "FarmIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "fieldIds": { + "description": "FieldIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "seasonIds": { + "description": "SeasonIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "cropProductIds": { + "description": "CropProductIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "cropIds": { + "description": "CropIds of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchTillageDataQuery": { + "description": "SearchTillageDataQuery.", + "type": "object", + "properties": { + "minTillageDepth": { + "format": "double", + "description": "Minimum measured tillage depth (inclusive).", + "type": "number" + }, + "maxTillageDepth": { + "format": "double", + "description": "Maximum measured tillage depth (inclusive).", + "type": "number" + }, + "minTillagePressure": { + "format": "double", + "description": "Minimum pressure applied to a tillage implement (inclusive).", + "type": "number" + }, + "maxTillagePressure": { + "format": "double", + "description": "Maximum pressure applied to a tillage implement (inclusive).", + "type": "number" + }, + "associatedResourceIds": { + "description": "Resource Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "associatedResourceType": { + "description": "Resource Types of the resource.\r\ni.e. Farmer, Farm, Field, SeasonalField, ApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.", + "type": "string" + }, + "minOperationStartDateTime": { + "format": "date-time", + "description": "Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationStartDateTime": { + "format": "date-time", + "description": "Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationEndDateTime": { + "format": "date-time", + "description": "Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationEndDateTime": { + "format": "date-time", + "description": "Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "minOperationModifiedDateTime": { + "format": "date-time", + "description": "Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "maxOperationModifiedDateTime": { + "format": "date-time", + "description": "Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).", + "type": "string" + }, + "sources": { + "description": "Sources of the operation data.", + "type": "array", + "items": { + "type": "string" + } + }, + "minArea": { + "format": "double", + "description": "Minimum acreage of the boundary (inclusive).", + "type": "number" + }, + "maxArea": { + "format": "double", + "description": "Maximum acreage of the boundary (inclusive).", + "type": "number" + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "SearchZoneQuery": { + "description": "Get Zones query parameters.", + "type": "object", + "properties": { + "types": { + "description": "Types of the Zones.", + "type": "array", + "items": { + "type": "string" + } + }, + "managementZoneIds": { + "description": "ManagementZoneIds of the Zones.", + "type": "array", + "items": { + "type": "string" + } + }, + "sources": { + "description": "Sources of the Zones.", + "type": "array", + "items": { + "type": "string" + } + }, + "ids": { + "description": "Ids of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "Names of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "propertyFilters": { + "description": "Filters on key-value pairs within the Properties object.\r\ne.g. \"{testKey} eq {testValue}\".", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "Statuses of the resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "minCreatedDateTime": { + "format": "date-time", + "description": "Minimum creation date of resource (inclusive).", + "type": "string" + }, + "maxCreatedDateTime": { + "format": "date-time", + "description": "Maximum creation date of resource (inclusive).", + "type": "string" + }, + "minLastModifiedDateTime": { + "format": "date-time", + "description": "Minimum last modified date of resource (inclusive).", + "type": "string" + }, + "maxLastModifiedDateTime": { + "format": "date-time", + "description": "Maximum last modified date of resource (inclusive).", + "type": "string" + }, + "intersectsWithGeometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string" + } + } + }, + "Season": { + "description": "Schema of season resource.", + "type": "object", + "properties": { + "startDateTime": { + "format": "date-time", + "description": "Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + }, + "year": { + "format": "int32", + "description": "Season year.", + "type": "integer" + }, + "geographicIdentifier": { + "description": "Geographic Identifier.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Season" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SeasonalField": { + "description": "Schema of seasonal field resource.", + "required": [ + "farmId" + ], + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "farmId": { + "description": "Id of the associated Farm.", + "minLength": 1, + "type": "string" + }, + "fieldId": { + "description": "Id of the associated Field.", + "type": "string" + }, + "seasonId": { + "description": "Id of the season it belongs to.", + "type": "string" + }, + "cropProductIds": { + "description": "CropProduct ids.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "cropId": { + "description": "Id of the crop it belongs to.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonalFieldMetaData": { + "description": "Schema of seasonal field resource.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id.", + "type": "string", + "readOnly": true + }, + "farmId": { + "description": "Id of the associated Farm.", + "type": "string" + }, + "fieldId": { + "description": "Id of the associated Field.", + "type": "string" + }, + "seasonId": { + "description": "Id of the season it belongs to.", + "type": "string" + }, + "cropProductIds": { + "description": "CropProduct ids.", + "uniqueItems": true, + "type": "array", + "items": { + "type": "string" + } + }, + "cropId": { + "description": "Id of the crop it belongs to.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SeasonalFieldMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SeasonalFieldMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "Sensor": { + "description": "Sensor API model.", + "type": "object", + "properties": { + "sensorDataModelId": { + "description": "Id of the associated sensor data model.", + "type": "string" + }, + "integrationId": { + "description": "Integration id for the device.", + "type": "string" + }, + "hardwareId": { + "description": "Id of the associated hardware.", + "type": "string" + }, + "deviceId": { + "description": "Id of the associated device.", + "type": "string" + }, + "type": { + "description": "Type of sensor.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "location": { + "$ref": "#/definitions/Location" + }, + "port": { + "$ref": "#/definitions/Port" + }, + "depthInMeters": { + "description": "Depth of each sensor measure in meters.\r\nLike sensor moisture at 2m, 4m, 6m.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorDataModel": { + "description": "SensorModel API model.", + "required": [ + "measures" + ], + "type": "object", + "properties": { + "type": { + "description": "Type of sensor.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "manufacturer": { + "description": "Sensor manufacturer.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "productCode": { + "description": "Sensor productCode.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "measures": { + "description": "Map of sensor type to sensor measures.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SensorDataModelMeasure" + } + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorDataModelListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorDataModel" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorDataModelMeasure": { + "description": "Sensor model measure details.", + "required": [ + "dataType" + ], + "type": "object", + "properties": { + "description": { + "description": "Description of sensor measure.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "dataType": { + "description": "Sensor measure data type.", + "maxLength": 100, + "minLength": 2, + "enum": [ + "Bool", + "Double", + "DateTime", + "Long", + "String" + ], + "type": "string", + "x-ms-enum": { + "name": "SensorDataType", + "modelAsString": true + } + }, + "type": { + "description": "Measurement type of sensor data.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "unit": { + "description": "Unit of sensor measure.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "properties": { + "description": "A collection of key value pairs for sensor data model.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a model and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + } + }, + "SensorEvent": { + "description": "Sensor event response model.", + "type": "object", + "properties": { + "sensorId": { + "description": "Id of the sensor.", + "type": "string" + }, + "sensorPartnerId": { + "description": "Id of the sensor partner.", + "type": "string" + }, + "partyId": { + "description": "Id of the associated party.", + "type": "string" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "eventDateTime": { + "format": "date-time", + "description": "DateTime of sensor event observation.", + "type": "string" + }, + "ingestionDateTime": { + "format": "date-time", + "description": "DateTime of sensor event ingestion to data store.", + "type": "string" + }, + "measures": { + "description": "Sensor measures.", + "type": "object", + "additionalProperties": {} + } + } + }, + "SensorEventListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorEvent" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Sensor" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorMapping": { + "description": "SensorMapping API model.", + "required": [ + "associatedResource" + ], + "type": "object", + "properties": { + "sensorId": { + "description": "Id of the associated sensor.", + "type": "string" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string" + }, + "partyId": { + "description": "Id of the associated party.", + "type": "string" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorMappingListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorMapping" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorPartnerIntegrationCheckConsentResponse": { + "description": "Sensor partner integration check consent response.", + "type": "object", + "properties": { + "consented": { + "description": "Flag to determine the status of partner integration consent.", + "type": "boolean" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "integrationId": { + "description": "Id of the integration.", + "type": "string", + "readOnly": true + } + } + }, + "SensorPartnerIntegrationGenerateConsentLinkResponse": { + "description": "Sensor partner integration generate consent link response.", + "type": "object", + "properties": { + "consentLink": { + "description": "Consent link.", + "type": "string", + "readOnly": true + }, + "consentExpiryDateTime": { + "format": "date-time", + "description": "Consent expiry date time, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string" + } + } + }, + "SensorPartnerIntegrationModel": { + "description": "Sensor partner integration model.", + "type": "object", + "properties": { + "integrationId": { + "description": "Id of the integration.", + "type": "string", + "readOnly": true + }, + "partyId": { + "description": "Id of the party.", + "type": "string" + }, + "sensorPartnerId": { + "description": "Id of the associated sensor partner.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the resource.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and\r\nonly string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "SensorPartnerIntegrationModelListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SensorPartnerIntegrationModel" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "SensorRenewConnectionStringModel": { + "description": "Model for renewing sensor's connection string.", + "required": [ + "connectionStringType" + ], + "type": "object", + "properties": { + "connectionStringType": { + "description": "Specifies the type of connection string key to be renewed valid values - Primary/Secondary/Both.", + "maxLength": 100, + "minLength": 0, + "enum": [ + "Primary", + "Secondary", + "Both" + ], + "type": "string", + "x-ms-enum": { + "name": "RenewConnectionStringType", + "modelAsString": true + } + } + } + }, + "SoilMoistureModelSensorDefinition": { + "description": "Schema for storing sensor definition keywords.", + "required": [ + "maxProperty", + "minProperty", + "sensorMeasurement" + ], + "type": "object", + "properties": { + "sensorMeasurement": { + "description": "The measurement name for sensor measure in sensorDataModel.", + "minLength": 1, + "type": "string" + }, + "minProperty": { + "description": "The measurement name for minimum measurement value.", + "minLength": 1, + "type": "string" + }, + "maxProperty": { + "description": "The measurement name for maximum measurement value.", + "minLength": 1, + "type": "string" + } + } + }, + "SolutionInference": { + "description": "SolutionInference request model.", + "required": [ + "requestPath" + ], + "type": "object", + "properties": { + "requestPath": { + "description": "RequestPath containing the api-version, query parameters and path route to be called for partner request.\r\nExpected format is \"/{api-version}/{resourceExposedByPartner}/{customerDefinedJobId}?query1=value1\".\r\nNot following this format may result into validation errors.", + "minLength": 1, + "type": "string" + }, + "partnerRequestBody": { + "description": "Api input parameters required by partner to trigger/cancel job request.", + "type": "object", + "additionalProperties": {} + }, + "partnerRequestHeaders": { + "description": "Additional Headers sent to partner.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StacItem": { + "description": "Schema of STAC Item.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#item-fields.", + "required": [ + "assets", + "id", + "links", + "properties", + "stacVersion", + "type" + ], + "type": "object", + "properties": { + "stacVersion": { + "description": "The STAC version the Stac Item implements.", + "minLength": 1, + "type": "string" + }, + "stacExtensions": { + "description": "A list of extensions the Stac Item implements.", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Provider identifier. Globally unique ID by Data provider.", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Type of the GeoJSON Object. It's value is always Feature.", + "minLength": 1, + "type": "string" + }, + "geometry": { + "description": "Defines the full footprint of the asset represented by this item.\r\nIts a GeoJSON geometry.", + "type": "object" + }, + "bbox": { + "description": "Bounding box of the item.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "properties": { + "description": "A dictionary of additional metadata for the item.", + "type": "object" + }, + "links": { + "description": "List of link objects to resources and related URLs.", + "type": "array", + "items": { + "$ref": "#/definitions/StacItemLink" + } + }, + "assets": { + "description": "Dictionary of asset objects, each with a unique key.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StacItemAsset" + } + }, + "collection": { + "description": "The id of the STAC Collection this Stac Item references.", + "type": "string" + } + } + }, + "StacItemAsset": { + "description": "Schema of STAC Item's Asset.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#asset-object.", + "required": [ + "href" + ], + "type": "object", + "properties": { + "href": { + "description": "Link to the asset object.", + "minLength": 1, + "type": "string" + }, + "title": { + "description": "The displayed title for clients and users.", + "type": "string" + }, + "description": { + "description": "A description of the Asset providing additional details, such as how it was processed or created.", + "type": "string" + }, + "type": { + "description": "Media type of the asset.", + "type": "string" + }, + "roles": { + "description": "The semantic roles of the asset, similar to the use of rel in links.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "StacItemLink": { + "description": "The Link object describes a relationship of this Stac Item with another entity.\r\nRefer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#link-object.", + "required": [ + "href", + "rel" + ], + "type": "object", + "properties": { + "href": { + "description": "The actual link in the format of an URL.", + "minLength": 1, + "type": "string" + }, + "rel": { + "description": "Relationship between the current document and the linked document.", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Media type of the referenced entity.", + "type": "string" + }, + "title": { + "description": "A human readable title to be used in rendered displays of the link.", + "type": "string" + } + } + }, + "TillageData": { + "description": "Schema of tillage data resource.", + "type": "object", + "properties": { + "tillageDepth": { + "$ref": "#/definitions/Measure" + }, + "tillagePressure": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "TillageDataMetaData": { + "description": "Schema of tillage data resource.", + "type": "object", + "properties": { + "tillageDepth": { + "$ref": "#/definitions/Measure" + }, + "tillagePressure": { + "$ref": "#/definitions/Measure" + }, + "area": { + "$ref": "#/definitions/Measure" + }, + "operationModifiedDateTime": { + "format": "date-time", + "description": "Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.\r\nNote: this will be specified by the source provider itself.", + "type": "string", + "example": "2021-02-10T11:10:21Z" + }, + "operationStartDateTime": { + "format": "date-time", + "description": "Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "operationEndDateTime": { + "format": "date-time", + "description": "End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2021-01-31T11:10:21Z" + }, + "associatedResource": { + "$ref": "#/definitions/GeoResource" + }, + "partyId": { + "description": "Party ID which belongs to the operation data.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "TillageDataMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/TillageDataMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + }, + "WeatherDataErrors": { + "description": "Model for errors encountered for all failed locations.", + "type": "object", + "properties": { + "locations": { + "description": "List of errors encountered for all failed locations.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorForLocation" + } + } + } + }, + "WeatherDataForPassthrough": { + "description": "Schema of weather data.", + "type": "object", + "properties": { + "additionalAttributes": { + "description": "A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 250 characters. Note: A maximum of 100 key value pairs can be provided for a resource and only string and numeral values are supported.", + "type": "object", + "additionalProperties": {} + }, + "wetBulbTemperature": { + "$ref": "#/definitions/Measures" + }, + "cloudCover": { + "$ref": "#/definitions/Measures" + }, + "dayOfWeek": { + "description": "Day of week.", + "type": "array", + "items": { + "type": "string" + } + }, + "dayOrNight": { + "description": "This data field indicates whether it is daytime or nighttime based on the Local Apparent Time of the location.", + "type": "array", + "items": { + "type": "string" + } + }, + "expirationTime": { + "description": "Expiration time in Utc format.", + "type": "array", + "items": { + "type": "string" + } + }, + "iconCode": { + "description": "This number is the key to the weather icon lookup. The data field shows the icon number that is matched to represent the observed weather conditions.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "iconCodeExtend": { + "description": "Code representing full set sensible weather.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "hasPrecipitation": { + "description": "Indicates whether there is precipitation or not.", + "type": "array", + "items": { + "type": "boolean" + } + }, + "pressureMeanSeaLevel": { + "$ref": "#/definitions/Measures" + }, + "relativeHumidity": { + "$ref": "#/definitions/Measures" + }, + "temperature": { + "$ref": "#/definitions/Measures" + }, + "temperatureDewPoint": { + "$ref": "#/definitions/Measures" + }, + "temperatureFeelsLike": { + "$ref": "#/definitions/Measures" + }, + "temperatureHeatIndex": { + "$ref": "#/definitions/Measures" + }, + "temperatureWindChill": { + "$ref": "#/definitions/Measures" + }, + "uvDescription": { + "description": "The UV Index Description which complements the UV Index value by providing an associated level of risk of skin damage due to exposure (-2 = Not Available, -1 = No Report, 0 to 2 = Low, 3 to 5 = Moderate, 6 to 7 = High, 8 to 10 = Very High, 11 to 16 = Extreme).", + "type": "array", + "items": { + "type": "string" + } + }, + "uvIndex": { + "description": "Hourly maximum UV index.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + }, + "validTimeLocal": { + "description": "Time forecast is valid in local apparent time.", + "type": "array", + "items": { + "type": "string" + } + }, + "validTime": { + "description": "Time forecast is valid in Utc format.", + "type": "array", + "items": { + "type": "string" + } + }, + "visibility": { + "$ref": "#/definitions/Measures" + }, + "windDirection": { + "$ref": "#/definitions/Measures" + }, + "windGust": { + "$ref": "#/definitions/Measures" + }, + "windSpeed": { + "$ref": "#/definitions/Measures" + }, + "wxPhraseLong": { + "description": "Hourly sensible weather phrase containing longer description.", + "type": "array", + "items": { + "type": "string" + } + }, + "wxPhraseShort": { + "description": "Hourly sensible weather phrase containing short description.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "WeatherDataProviderRequest": { + "description": "Schema of weather data provider request.", + "required": [ + "extensionApiName", + "extensionId", + "units" + ], + "type": "object", + "properties": { + "credentials": { + "$ref": "#/definitions/ApiKeyAuthCredentials" + }, + "locations": { + "description": "List of locations for which weather data need to be fetched from the provider.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherLocation" + } + }, + "extensionId": { + "description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "extensionApiName": { + "description": "Extension api name to which request is to be made.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "language": { + "description": "Language (IETF BCP 47 language tag) in which search results should be returned by the data provider. Examples: 'en-US', 'es', 'es-MX', 'fr-FR'.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "startTimeHours": { + "format": "int32", + "description": "Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "endTimeHours": { + "format": "int32", + "description": "End of time range. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "duration": { + "format": "int32", + "description": "Specifies for how many days the daily forecast responses are returned. Available values are 1, 5, 10, 25 and 45. (Only applicable for Azure Weather Maps extension.)", + "type": "integer" + }, + "units": { + "description": "Units for which request to data provider is to be sent. Supported values are 'e' for English units, 'm' for Metric units, 'h' for Hybrid units (UK) and 's' for Metric SI units.", + "minLength": 1, + "type": "string" + }, + "additionalParams": { + "$ref": "#/definitions/AdditionalProviderParameters" + } + } + }, + "WeatherDataProviderResponse": { + "description": "Schema of Weather Data Provider Response.", + "required": [ + "weatherMetadata" + ], + "type": "object", + "properties": { + "weatherMetadata": { + "$ref": "#/definitions/WeatherMetadata" + }, + "status": { + "description": "Indicates a Succeeded, Failed, or PartiallySucceeded response.", + "enum": [ + "Succeeded", + "Failed", + "PartiallySucceeded" + ], + "type": "string", + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "locations": { + "description": "List of weather data for all the weather locations.", + "type": "array", + "items": { + "$ref": "#/definitions/WeatherLocationData" + } + }, + "errors": { + "$ref": "#/definitions/WeatherDataErrors" + } + } + }, + "WeatherLocation": { + "description": "Schema of Location data.", + "required": [ + "type", + "value" + ], + "type": "object", + "properties": { + "type": { + "description": "Location Type eg. LatLong/IataCode/IcaoCode/Placeid/PostalKey.", + "maxLength": 25, + "minLength": 2, + "enum": [ + "LatLong", + "IataCode", + "IcaoCode", + "PlaceId", + "PostalKey" + ], + "type": "string", + "x-ms-enum": { + "name": "LocationType", + "modelAsString": true + } + }, + "value": { + "description": "Location Value eg. \"10,-25\" for LocationType Type \"LatLong\".", + "maxLength": 100, + "minLength": 2, + "type": "string" + } + } + }, + "WeatherLocationData": { + "description": "Schema of WeatherLocationData data.", + "type": "object", + "properties": { + "location": { + "$ref": "#/definitions/WeatherLocation" + }, + "requestCompletionTime": { + "description": "Request Completion Time in Utc of the location.", + "type": "string" + }, + "lastRefreshedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last requested, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "example": "2020-12-31T11:10:21Z" + }, + "data": { + "$ref": "#/definitions/WeatherDataForPassthrough" + } + } + }, + "WeatherMetadata": { + "description": "Schema of Weather Metadata.", + "required": [ + "extensionApiName", + "extensionId", + "extensionVersion", + "units", + "weatherDataType" + ], + "type": "object", + "properties": { + "extensionVersion": { + "description": "Version of the weather data extension.", + "minLength": 1, + "type": "string" + }, + "weatherDataType": { + "description": "Type of weather data (forecast/historical).", + "minLength": 1, + "type": "string" + }, + "extensionId": { + "description": "Id of the extension to be used for the providerInput. eg. DTN.ClearAg.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "extensionApiName": { + "description": "Extension api name to which request is to be made.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "language": { + "description": "Language (IETF BCP 47 language tag) in which search results should be returned by the data provider. Examples: 'en-US', 'es', 'es-MX', 'fr-FR'.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "startTimeHours": { + "format": "int32", + "description": "Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "endTimeHours": { + "format": "int32", + "description": "End of time range. (Only applicable for DTN.ClearAg extension.)", + "maximum": 240, + "minimum": 0, + "type": "integer" + }, + "duration": { + "format": "int32", + "description": "Specifies for how many days the daily forecast responses are returned. Available values are 1, 5, 10, 25 and 45. (Only applicable for Azure Weather Maps extension.)", + "type": "integer" + }, + "units": { + "description": "Units for which request to data provider is to be sent. Supported values are 'e' for English units, 'm' for Metric units, 'h' for Hybrid units (UK) and 's' for Metric SI units.", + "minLength": 1, + "type": "string" + }, + "additionalParams": { + "$ref": "#/definitions/AdditionalProviderParameters" + } + } + }, + "Zone": { + "description": "Api Model for Zone object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id associated with the Zone.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the Zone.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "managementZoneId": { + "description": "Management Zone Id associated with the Zone.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJsonObject" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ZoneMetaData": { + "description": "Api Model for Zone object.", + "type": "object", + "properties": { + "partyId": { + "description": "Party Id associated with the Zone.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the Zone.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "managementZoneId": { + "description": "Management Zone Id associated with the Zone.", + "type": "string" + }, + "id": { + "description": "Unique resource ID.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "modifiedDateTime": { + "format": "date-time", + "description": "Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.", + "type": "string", + "readOnly": true, + "example": "2020-12-31T11:10:21Z" + }, + "source": { + "description": "Source of the resource.", + "maxLength": 100, + "minLength": 2, + "type": "string" + }, + "name": { + "description": "Name to identify resource.", + "maxLength": 100, + "minLength": 0, + "type": "string" + }, + "description": { + "description": "Textual description of the resource.", + "maxLength": 500, + "minLength": 0, + "type": "string" + }, + "createdBy": { + "description": "Created by user/tenant id.", + "type": "string", + "readOnly": true + }, + "modifiedBy": { + "description": "Modified by user/tenant id.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.", + "type": "object", + "additionalProperties": {}, + "example": { + "key1": "value1", + "key2": 123.45 + } + } + } + }, + "ZoneMetaDataListResponse": { + "description": "Paged response contains list of requested objects and a skipToken to get the next set of results.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ZoneMetaData" + } + }, + "skipToken": { + "description": "Token used in retrieving the next page. If null, there are no additional pages.", + "type": "string" + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string" + } + } + } + }, + "securityDefinitions": { + "Bearer": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before." + } + }, + "security": [ + { + "Bearer": [] + } + ] +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..3ce8de7af907 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "ApplicationData123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationapplicationdata' resource with id 'ApplicationData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "ApplicationData123", + "resourceType": "farmoperationapplicationdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_CreateOrUpdate.json new file mode 100644 index 000000000000..7abf61d5564d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_CreateOrUpdate.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "APPLICATION123", + "api-version": "2023-11-01-preview", + "applicationData": { + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_Delete.json new file mode 100644 index 000000000000..173416e2eb80 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "APPLICATION123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_Get.json new file mode 100644 index 000000000000..ebce19c69e43 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "partyId": "PARTY123", + "applicationDataId": "APPLICATION123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2020-12-31T11:10:21Z", + "modifiedDateTime": "2020-12-31T11:10:21Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..5ea9400514c8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "ApplicationData123", + "resourceType": "farmoperationapplicationdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_Search.json new file mode 100644 index 000000000000..19f1d1e1e828 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ApplicationData_Search.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "maxPageSize": 50, + "searchFarmOperationQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "APPLICATION123", + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T11:12:12Z", + "area": { + "unit": "acre", + "value": 60 + }, + "totalMaterial": { + "unit": "kilos", + "value": 9 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.15 + }, + "applicationProductDetails": [ + { + "productName": "POTASHVAR1", + "isCarrier": false, + "totalMaterial": { + "unit": "kilos", + "value": 4 + }, + "avgMaterial": { + "unit": "kilosperacre", + "value": 0.2 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_CreateOrUpdate.json new file mode 100644 index 000000000000..b18648fdb703 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_CreateOrUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-11-01-preview", + "file": "101010101" + }, + "responses": { + "200": { + "body": { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_Delete.json new file mode 100644 index 000000000000..4e77a4c2530e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_Download.json new file mode 100644 index 000000000000..48c6598b63d4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_Download.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_Get.json new file mode 100644 index 000000000000..4d4da1945a09 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "partyId": "PARTY123", + "attachmentId": "ATTACHMENT123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_ListByPartyId.json new file mode 100644 index 000000000000..433046de593c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Attachments_ListByPartyId.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "ATTACHMENT123", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "Party", + "originalFileName": "attachment-file", + "name": "John Smith's attachment", + "status": "Active", + "description": "Some description", + "source": "source", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/attachments/{{attachmentId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_CreateOrUpdate.json new file mode 100644 index 000000000000..438ad3156baf --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_CreateOrUpdate.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "chemicalProductId": "Chemical123", + "chemicalProduct": { + "cropIds": [ + "CropId" + ], + "reference": { + "datasetId": "datasetId", + "recordId": "recordId" + }, + "brand": "Brand", + "product": "AGTECH", + "type": "Herbicide", + "state": "Liquid", + "activeIngredients": [ + "NO2" + ], + "specificGravity": "string", + "formulation": "N, P, K", + "company": { + "name": "CompanyName", + "description": "Agriculture Manufacturer", + "registrationNumber": "1234" + }, + "location": "US", + "registrationNumber": "1234", + "reEntryInterval": 5, + "status": "Active", + "source": "Manufacturer", + "name": "Fertilizer1", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "id": "Chemical123", + "cropIds": [ + "CropId" + ], + "reference": { + "datasetId": "datasetId", + "recordId": "recordId" + }, + "brand": "Brand", + "product": "AGTECH", + "type": "Herbicide", + "state": "Liquid", + "activeIngredients": [ + "NO2" + ], + "specificGravity": "string", + "formulation": "N, P, K", + "company": { + "name": "CompanyName", + "description": "Agriculture Manufacturer", + "registrationNumber": "1234" + }, + "location": "US", + "registrationNumber": "1234", + "reEntryInterval": 5, + "status": "Active", + "source": "Manufacturer", + "name": "Fertilizer1", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "Chemical123", + "cropIds": [ + "CropId" + ], + "reference": { + "datasetId": "datasetId", + "recordId": "recordId" + }, + "brand": "Brand", + "product": "AGTECH", + "type": "Herbicide", + "state": "Liquid", + "activeIngredients": [ + "NO2" + ], + "specificGravity": "string", + "formulation": "N, P, K", + "company": { + "name": "CompanyName", + "description": "Agriculture Manufacturer", + "registrationNumber": "1234" + }, + "location": "US", + "registrationNumber": "1234", + "reEntryInterval": 5, + "status": "Active", + "source": "Manufacturer", + "name": "Fertilizer1", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_Delete.json new file mode 100644 index 000000000000..cf97e7883a5d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "chemicalProductId": "Chemical123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_Get.json new file mode 100644 index 000000000000..437eac2e6f61 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "chemicalProductId": "Chemical123" + }, + "responses": { + "200": { + "body": { + "id": "Chemical123", + "cropIds": [ + "CropId" + ], + "reference": { + "datasetId": "datasetId", + "recordId": "recordId" + }, + "brand": "Brand", + "product": "AGTECH", + "type": "Herbicide", + "state": "Liquid", + "activeIngredients": [ + "NO2" + ], + "specificGravity": "string", + "formulation": "N, P, K", + "company": { + "name": "CompanyName", + "description": "Agriculture Manufacturer", + "registrationNumber": "1234" + }, + "location": "US", + "registrationNumber": "1234", + "reEntryInterval": 5, + "status": "Active", + "source": "Manufacturer", + "name": "Fertilizer1", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_List.json new file mode 100644 index 000000000000..4477770201d9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ChemicalProducts_List.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "Chemical123", + "cropIds": [ + "CropId" + ], + "reference": { + "datasetId": "datasetId", + "recordId": "recordId" + }, + "brand": "Brand", + "product": "AGTECH", + "type": "Herbicide", + "state": "Liquid", + "activeIngredients": [ + "NO2" + ], + "specificGravity": "string", + "formulation": "N, P, K", + "company": { + "name": "CompanyName", + "description": "Agriculture Manufacturer", + "registrationNumber": "1234" + }, + "location": "US", + "registrationNumber": "1234", + "reEntryInterval": 5, + "status": "Active", + "source": "Manufacturer", + "name": "Fertilizer1", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/chemical-products/{{chemicalProductId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_CreateOrUpdate.json new file mode 100644 index 000000000000..f9e5e0cc8702 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_CreateOrUpdate.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "cropIds": [ + "CORN123" + ], + "cropProductId": "SEED123", + "cropProduct": { + "brand": "BRAND123", + "product": "AGTECH", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "status": "Active", + "name": "John Smith's Crop", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "SEED123", + "cropIds": [ + "CORN123" + ], + "brand": "BRAND123", + "product": "AGTECH", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "SEED123", + "cropIds": [ + "CORN123" + ], + "brand": "BRAND123", + "product": "AGTECH", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_Delete.json new file mode 100644 index 000000000000..c86d60a57007 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "cropId": "CORN123", + "cropProductId": "SEED123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_Get.json new file mode 100644 index 000000000000..781c6ae9a4b4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "cropId": "CORN123", + "cropProductId": "SEED123" + }, + "responses": { + "200": { + "body": { + "id": "SEED123", + "brand": "BRAND123", + "product": "AGTECH", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_List.json new file mode 100644 index 000000000000..e7a778ebaa81 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/CropProducts_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEED123", + "brand": "BRAND123", + "product": "AGTECH", + "relativeMaturity": { + "unit": "string", + "value": 0 + }, + "treatments": [ + "string" + ], + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/crop-products/{{cropProductId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_CreateOrUpdate.json new file mode 100644 index 000000000000..0a4e862540ba --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_CreateOrUpdate.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "cropId": "CORN123", + "crop": { + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "status": "Active", + "name": "John Smith's Crop", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_Delete.json new file mode 100644 index 000000000000..db4889d4e05e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "cropId": "CORN123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_Get.json new file mode 100644 index 000000000000..93b11d7b1432 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "cropId": "CORN123" + }, + "responses": { + "200": { + "body": { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_List.json new file mode 100644 index 000000000000..e072a835edf4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Crops_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "CORN123", + "phenotype": "Corn", + "breedingMethod": "VARIETY", + "measurements": { + "m1": { + "unit": "string", + "value": 0 + }, + "m2": { + "unit": "string", + "value": 0 + }, + "m3": { + "unit": "string", + "value": 0 + } + }, + "name": "John Smith's Crop", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_CreateOrUpdate.json new file mode 100644 index 000000000000..6faa9ef7b989 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_CreateOrUpdate.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "datasetId": "Dataset1", + "recordId": "Record1", + "datasetRecord": { + "record": { + "name": "Cimegra", + "code": "cimegra", + "Company": "BASF", + "MatterStateCode": "liquid", + "RegulatorNumbers": [ + "33666" + ], + "ChemicalTypeCodes": [ + "insecticide" + ], + "ChemicalTypeNames": [ + "Insecticide" + ], + "SubstanceCodes": [ + "broflanilide" + ], + "SubstanceNames": [ + "Broflanilide" + ], + "SubstancePercentages": 10, + "CreatedAtDate": "2023-05-30T11:10:21Z", + "UpdatedAtDate": "2023-06-30T11:10:21Z" + }, + "status": "string", + "source": "string", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "datasetId": "Dataset1", + "record": { + "name": "Cimegra", + "code": "cimegra", + "Company": "BASF", + "MatterStateCode": "liquid", + "RegulatorNumbers": [ + "33666" + ], + "ChemicalTypeCodes": [ + "insecticide" + ], + "ChemicalTypeNames": [ + "Insecticide" + ], + "SubstanceCodes": [ + "broflanilide" + ], + "SubstanceNames": [ + "Broflanilide" + ], + "SubstancePercentages": 10, + "CreatedAtDate": "2023-05-30T11:10:21Z", + "UpdatedAtDate": "2023-06-30T11:10:21Z" + }, + "id": "Record1", + "status": "string", + "source": "string", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "datasetId": "Dataset1", + "record": { + "name": "Cimegra", + "code": "cimegra", + "Company": "BASF", + "MatterStateCode": "liquid", + "RegulatorNumbers": [ + "33666" + ], + "ChemicalTypeCodes": [ + "insecticide" + ], + "ChemicalTypeNames": [ + "Insecticide" + ], + "SubstanceCodes": [ + "broflanilide" + ], + "SubstanceNames": [ + "Broflanilide" + ], + "SubstancePercentages": 10, + "CreatedAtDate": "2023-05-30T11:10:21Z", + "UpdatedAtDate": "2023-06-30T11:10:21Z" + }, + "id": "Record1", + "status": "string", + "source": "string", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_Delete.json new file mode 100644 index 000000000000..b6c6e701e380 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "datasetId": "Dataset1", + "recordId": "Record1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_Get.json new file mode 100644 index 000000000000..cbe6941e5c9d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "datasetId": "Dataset1", + "recordId": "Record1" + }, + "responses": { + "200": { + "body": { + "datasetId": "Dataset1", + "record": { + "name": "Cimegra", + "code": "cimegra", + "Company": "BASF", + "MatterStateCode": "liquid", + "RegulatorNumbers": [ + "33666" + ], + "ChemicalTypeCodes": [ + "insecticide" + ], + "ChemicalTypeNames": [ + "Insecticide" + ], + "SubstanceCodes": [ + "broflanilide" + ], + "SubstanceNames": [ + "Broflanilide" + ], + "SubstancePercentages": 10, + "CreatedAtDate": "2023-05-30T11:10:21Z", + "UpdatedAtDate": "2023-06-30T11:10:21Z" + }, + "id": "Record1", + "status": "string", + "source": "string", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_List.json new file mode 100644 index 000000000000..c476733fd35f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DatasetRecords_List.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "datasetId": "Dataset1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "datasetId": "Dataset1", + "record": { + "name": "Cimegra", + "code": "cimegra", + "Company": "BASF", + "MatterStateCode": "liquid", + "RegulatorNumbers": [ + "33666" + ], + "ChemicalTypeCodes": [ + "insecticide" + ], + "ChemicalTypeNames": [ + "Insecticide" + ], + "SubstanceCodes": [ + "broflanilide" + ], + "SubstanceNames": [ + "Broflanilide" + ], + "SubstancePercentages": 10, + "CreatedAtDate": "2023-05-30T11:10:21Z", + "UpdatedAtDate": "2023-06-30T11:10:21Z" + }, + "id": "Record1", + "status": "string", + "source": "string", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_AuthorizeAccess.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_AuthorizeAccess.json new file mode 100644 index 000000000000..06a5f2754cda --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_AuthorizeAccess.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "datasetId": "Dataset1", + "datasetAccess": { + "subscriptionId": "00000000-0000-0000-0000-000000000000" + } + }, + "responses": { + "200": { + "body": { + "subscriptionId": "00000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_CreateOrUpdate.json new file mode 100644 index 000000000000..9b630aedcb95 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_CreateOrUpdate.json @@ -0,0 +1,257 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "datasetId": "Dataset1", + "dataset": { + "type": "Chemical", + "recordsSchema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 2, + "maxLength": 100 + }, + "code": { + "type": "string" + }, + "Company": { + "type": "string" + }, + "MatterStateCode": { + "type": "string" + }, + "RegulatorNumbers": { + "type": "array", + "items": { + "type": "string" + } + }, + "ChemicalTypeCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "ChemicalTypeNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstanceCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstanceNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstancePercentages": { + "type": "number", + "maximum": 100, + "minimum": 0 + }, + "CreatedAtDate": { + "type": "string", + "format": "date-time" + }, + "UpdatedAtDate": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "Company", + "name" + ], + "additionalProperties": false + }, + "status": "string", + "source": "Partner", + "name": "Chemical Dataset", + "description": "Chemical Dataset", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Chemical", + "recordsSchema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 2, + "maxLength": 100 + }, + "code": { + "type": "string" + }, + "Company": { + "type": "string" + }, + "MatterStateCode": { + "type": "string" + }, + "RegulatorNumbers": { + "type": "array", + "items": { + "type": "string" + } + }, + "ChemicalTypeCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "ChemicalTypeNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstanceCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstanceNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstancePercentages": { + "type": "number", + "maximum": 100, + "minimum": 0 + }, + "CreatedAtDate": { + "type": "string", + "format": "date-time" + }, + "UpdatedAtDate": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "Company", + "name" + ], + "additionalProperties": false + }, + "id": "Dataset1", + "status": "string", + "createdDateTime": "2023-10-17T17:52:44Z", + "modifiedDateTime": "2023-10-17T17:52:44Z", + "source": "Partner", + "name": "Chemical Dataset", + "description": "Chemical Dataset", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "type": "Chemical", + "recordsSchema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 2, + "maxLength": 100 + }, + "code": { + "type": "string" + }, + "Company": { + "type": "string" + }, + "MatterStateCode": { + "type": "string" + }, + "RegulatorNumbers": { + "type": "array", + "items": { + "type": "string" + } + }, + "ChemicalTypeCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "ChemicalTypeNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstanceCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstanceNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstancePercentages": { + "type": "number", + "maximum": 100, + "minimum": 0 + }, + "CreatedAtDate": { + "type": "string", + "format": "date-time" + }, + "UpdatedAtDate": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "Company", + "name" + ], + "additionalProperties": false + }, + "id": "Dataset1", + "eTag": "43009725-0000-0700-0000-652ec9ec0000", + "status": "string", + "createdDateTime": "2023-10-17T17:52:44Z", + "modifiedDateTime": "2023-10-17T17:52:44Z", + "source": "Partner", + "name": "Chemical Dataset", + "description": "Chemical Dataset", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_Delete.json new file mode 100644 index 000000000000..08a784186f02 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "datasetId": "Dataset1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_Get.json new file mode 100644 index 000000000000..63e9f594e564 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_Get.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "datasetId": "Dataset1" + }, + "responses": { + "200": { + "body": { + "type": "Chemical", + "recordsSchema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 2, + "maxLength": 100 + }, + "code": { + "type": "string" + }, + "Company": { + "type": "string" + }, + "MatterStateCode": { + "type": "string" + }, + "RegulatorNumbers": { + "type": "array", + "items": { + "type": "string" + } + }, + "ChemicalTypeCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "ChemicalTypeNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstanceCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstanceNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstancePercentages": { + "type": "number", + "maximum": 100, + "minimum": 0 + }, + "CreatedAtDate": { + "type": "string", + "format": "date-time" + }, + "UpdatedAtDate": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "Company", + "name" + ], + "additionalProperties": false + }, + "id": "Dataset1", + "eTag": "43009725-0000-0700-0000-652ec9ec0000", + "status": "string", + "createdDateTime": "2023-10-17T17:52:44Z", + "modifiedDateTime": "2023-10-17T17:52:44Z", + "source": "Partner", + "name": "Chemical Dataset", + "description": "Chemical Dataset", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_List.json new file mode 100644 index 000000000000..26f028820a6a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_List.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Chemical", + "recordsSchema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 2, + "maxLength": 100 + }, + "code": { + "type": "string" + }, + "Company": { + "type": "string" + }, + "MatterStateCode": { + "type": "string" + }, + "RegulatorNumbers": { + "type": "array", + "items": { + "type": "string" + } + }, + "ChemicalTypeCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "ChemicalTypeNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstanceCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstanceNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "SubstancePercentages": { + "type": "number", + "maximum": 100, + "minimum": 0 + }, + "CreatedAtDate": { + "type": "string", + "format": "date-time" + }, + "UpdatedAtDate": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "Company", + "name" + ], + "additionalProperties": false + }, + "id": "Dataset1", + "eTag": "43009725-0000-0700-0000-652ec9ec0000", + "status": "string", + "createdDateTime": "2023-10-17T17:52:44Z", + "modifiedDateTime": "2023-10-17T17:52:44Z", + "source": "Partner", + "name": "Chemical Dataset", + "description": "Chemical Dataset", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_ListAuthorizedAccess.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_ListAuthorizedAccess.json new file mode 100644 index 000000000000..63069093accc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_ListAuthorizedAccess.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "datasetId": "Dataset1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + { + "resourceId": "ADMAResourceId1" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/datasets/{datasetId}/access?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_RemoveAccess.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_RemoveAccess.json new file mode 100644 index 000000000000..15078357465a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Datasets_RemoveAccess.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "datasetId": "Dataset1", + "datasetAccess": { + "subscriptionId": "00000000-0000-0000-0000-000000000000" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_CreateOrUpdate.json new file mode 100644 index 000000000000..59d38fbdfe43 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_CreateOrUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceDataModelId": "ddm124", + "api-version": "2023-11-01-preview", + "deviceDataModelObject": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "status": "new", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:54:08Z", + "eTag": "7f002a96-0000-0700-0000-61ea82c00000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:52:16Z", + "eTag": "7f00bf76-0000-0700-0000-61ea82500000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_Delete.json new file mode 100644 index 000000000000..92ea74ec22e2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceDataModelId": "ddm124", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_Get.json new file mode 100644 index 000000000000..562d093c5895 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "sp1", + "deviceDataModelId": "ddm124" + }, + "responses": { + "200": { + "body": { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:54:08Z", + "eTag": "7f002a96-0000-0700-0000-61ea82c00000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_List.json new file mode 100644 index 000000000000..29c74e27cf7a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/DeviceDataModels_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Node", + "manufacturer": "Manufacturer1", + "productCode": "smt123", + "ports": [ + { + "name": "sm", + "type": "Analog" + } + ], + "sensorPartnerId": "sp1", + "id": "ddm124", + "status": "new", + "createdDateTime": "2022-01-21T09:52:16Z", + "modifiedDateTime": "2022-01-21T09:54:08Z", + "eTag": "7f002a96-0000-0700-0000-61ea82c00000", + "name": "sm-device-model", + "description": "new device model for soil moisture measurement devices", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/device-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_CreateOrUpdate.json new file mode 100644 index 000000000000..1efb245e7c29 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_CreateOrUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceId": "d124", + "api-version": "2023-11-01-preview", + "deviceDetails": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "status": "new device", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d123", + "status": "new device", + "createdDateTime": "2022-01-24T06:20:47Z", + "modifiedDateTime": "2022-01-24T06:21:07Z", + "eTag": "0401a5cc-0000-0700-0000-61ee45540000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d123", + "status": "new device", + "createdDateTime": "2022-01-24T06:20:47Z", + "modifiedDateTime": "2022-01-24T06:20:47Z", + "eTag": "0401baca-0000-0700-0000-61ee453f0000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_Delete.json new file mode 100644 index 000000000000..19d8b9b36a5f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "deviceId": "d124", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_Get.json new file mode 100644 index 000000000000..8ac9557d8d69 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "sp1", + "deviceId": "d124" + }, + "responses": { + "200": { + "body": { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d124", + "status": "new device", + "createdDateTime": "2022-01-24T06:22:41Z", + "modifiedDateTime": "2022-01-24T06:22:43Z", + "eTag": "04010fd5-0000-0700-0000-61ee45b30000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_List.json new file mode 100644 index 000000000000..a629fbb5bbe0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Devices_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deviceDataModelId": "ddm124", + "integrationId": "string", + "type": "device", + "hardwareId": "HD156", + "reportingIntervalInSeconds": 10, + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "sensorPartnerId": "sp1", + "id": "d124", + "status": "new device", + "createdDateTime": "2022-01-24T06:22:41Z", + "modifiedDateTime": "2022-01-24T06:22:43Z", + "eTag": "04010fd5-0000-0700-0000-61ee45b30000", + "name": "my device", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/device-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_CreateOrUpdate.json new file mode 100644 index 000000000000..48e1e658e80d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_CreateOrUpdate.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "farmEquipmentId": "Equipment123", + "farmEquipment": { + "cropIds": [ + "CropId" + ], + "reference": { + "datasetId": "datasetId", + "recordId": "recordId" + }, + "brand": "string", + "series": "H", + "model": "1234", + "serial": "1234", + "type": "Harvester", + "ownership": "Personal", + "location": "US", + "company": { + "name": "Company123", + "description": "Equipment manufacturer", + "registrationNumber": "1234" + }, + "status": "Active", + "source": "Manufacturer", + "name": "Equipment1", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "id": "Equipment123", + "cropIds": [ + "CropId" + ], + "reference": { + "datasetId": "datasetId", + "recordId": "recordId" + }, + "brand": "string", + "series": "H", + "model": "1234", + "serial": "1234", + "type": "Harvester", + "ownership": "Personal", + "location": "US", + "company": { + "name": "Company123", + "description": "Equipment manufacturer", + "registrationNumber": "1234" + }, + "status": "Active", + "source": "Manufacturer", + "name": "Equipment1", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "Equipment123", + "cropIds": [ + "CropId" + ], + "reference": { + "datasetId": "datasetId", + "recordId": "recordId" + }, + "brand": "string", + "series": "H", + "model": "1234", + "serial": "1234", + "type": "Harvester", + "ownership": "Personal", + "location": "US", + "company": { + "name": "Company123", + "description": "Equipment manufacturer", + "registrationNumber": "1234" + }, + "status": "Active", + "source": "Manufacturer", + "name": "Equipment1", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_Delete.json new file mode 100644 index 000000000000..270b3fb0cefb --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "farmEquipmentId": "Equipment123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_Get.json new file mode 100644 index 000000000000..a733dff90f47 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "farmEquipmentId": "Equipment123" + }, + "responses": { + "200": { + "body": { + "id": "Equipment123", + "cropIds": [ + "CropId" + ], + "reference": { + "datasetId": "datasetId", + "recordId": "recordId" + }, + "brand": "string", + "series": "H", + "model": "1234", + "serial": "1234", + "type": "Harvester", + "ownership": "Personal", + "location": "US", + "company": { + "name": "Company123", + "description": "Equipment manufacturer", + "registrationNumber": "1234" + }, + "status": "Active", + "source": "Manufacturer", + "name": "Equipment1", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_List.json new file mode 100644 index 000000000000..5d640b685be2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmEquipments_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "Equipment123", + "cropIds": [ + "CropId" + ], + "reference": { + "datasetId": "datasetId", + "recordId": "recordId" + }, + "brand": "string", + "series": "H", + "model": "1234", + "serial": "1234", + "type": "Harvester", + "ownership": "Personal", + "location": "US", + "company": { + "name": "Company123", + "description": "Equipment manufacturer", + "registrationNumber": "1234" + }, + "status": "Active", + "source": "Manufacturer", + "name": "Equipment1", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/chemical-products/{{chemicalProductId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmOperations_CreateDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmOperations_CreateDataIngestionJob.json new file mode 100644 index 000000000000..5e053779c71d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmOperations_CreateDataIngestionJob.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-11-01-preview", + "job": { + "partyId": "TEST-PARTY", + "authProviderId": "JOHNDEERE", + "operations": [ + "AllOperations" + ], + "providerInput": { + "shapeType": "Point", + "shapeResolution": "EachSection" + }, + "startYear": 2012, + "name": "Farm Operations Job", + "description": "For TEST-PARTY", + "properties": { + "Operation": "All" + } + } + }, + "responses": { + "202": { + "body": { + "operations": [ + "AllOperations" + ], + "startYear": 2012, + "providerInput": { + "shapeType": "Point", + "shapeResolution": "EachSection" + }, + "durationInSeconds": 14.79, + "id": "sdi-0916aeec-ad8d-41d0-9797-63924f818cd7", + "status": "Waiting", + "message": "string", + "createdDateTime": "2021-03-15T07:14:14Z", + "lastActionDateTime": "2021-03-15T07:14:14Z", + "startTime": "2021-03-15T07:14:14Z", + "endTime": "2021-03-15T07:14:14Z", + "name": "Farm Operations Job", + "description": "For TEST-PARTY", + "properties": { + "Operation": "All" + }, + "partyId": "TEST-PARTY", + "authProviderId": "JOHNDEERE" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmOperations_GetDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmOperations_GetDataIngestionJobDetails.json new file mode 100644 index 000000000000..a6c4c1716826 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/FarmOperations_GetDataIngestionJobDetails.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "providerInput": { + "shapeType": "Point", + "shapeResolution": "EachSection" + }, + "durationInSeconds": 11.2, + "id": "farm-operations-job", + "status": "Succeeded", + "message": "string", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "name": "Farm operations Job", + "description": "Test job", + "properties": { + "Region": "Asia" + }, + "partyId": "PARTY123", + "authProviderId": "JOHNDEERE", + "operations": [ + "AllOperations" + ], + "startYear": 2012 + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..2d209068b98d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "farmId": "FARM123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FARM123", + "resourceType": "farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_CreateOrUpdate.json new file mode 100644 index 000000000000..ac4688159621 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "partyId": "PARTY123", + "farmId": "FARM123", + "api-version": "2023-11-01-preview", + "farm": { + "status": "Active", + "name": "John Smith's Farm", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_Delete.json new file mode 100644 index 000000000000..639cb8575b6b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "farmId": "FARM123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_Get.json new file mode 100644 index 000000000000..b7482434d7a6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "farmId": "FARM123" + }, + "responses": { + "200": { + "body": { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..e4d57eb13d7e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FARM123", + "resourceType": "farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_List.json new file mode 100644 index 000000000000..3d412cfd1b4a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_ListByPartyId.json new file mode 100644 index 000000000000..e48ad6fe5113 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Farms_ListByPartyId.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FARM123", + "partyId": "PARTY123", + "name": "John Smith's Farm", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/farms/{{farmId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..9849bdca9279 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "fieldId": "FIELD123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FIELD123", + "resourceType": "field" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_CreateOrUpdate.json new file mode 100644 index 000000000000..16dfd7994db2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_CreateOrUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "partyId": "PARTY123", + "fieldId": "FIELD123", + "api-version": "2023-11-01-preview", + "field": { + "farmId": "FARM123", + "status": "Active", + "name": "John Smith's Field", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_Delete.json new file mode 100644 index 000000000000..b6feccc1cd9c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "fieldId": "FIELD123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_Get.json new file mode 100644 index 000000000000..29be37e397fe --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "fieldId": "FIELD123" + }, + "responses": { + "200": { + "body": { + "id": "FIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..502fd69db212 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "FIELD123", + "resourceType": "field" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_Search.json new file mode 100644 index 000000000000..a84ea6c16274 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Fields_Search.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "maxPageSize": 50, + "searchFieldQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "FIELD123", + "partyId": "FARMER123", + "farmId": "FARM123", + "name": "John Smith's Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..c444d7c57419 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "harvestDataId": "HarvestData123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationharvestdata' resource with id 'HarvestData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "HarvestData123", + "resourceType": "farmoperationharvestdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_CreateOrUpdate.json new file mode 100644 index 000000000000..1449551e24d9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_CreateOrUpdate.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "harvestDataId": "HARVESTOP123", + "harvestData": { + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_Delete.json new file mode 100644 index 000000000000..b213833b65fd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "harvestDataId": "HARVESTOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_Get.json new file mode 100644 index 000000000000..59392a33d371 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_Get.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "harvestDataId": "HARVESTOP123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..78924d36fd82 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 15, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "HarvestData123", + "resourceType": "farmoperationharvestdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_Search.json new file mode 100644 index 000000000000..b7d3c50e6610 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/HarvestData_Search.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "maxPageSize": 50, + "searchFarmOperationQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "FARMER123", + "id": "HARVESTOP123", + "source": "Manual", + "name": "Harvest data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "area": { + "unit": "acre", + "value": 50 + }, + "totalYield": { + "unit": "kilos", + "value": 1400 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 28 + }, + "totalWetMass": { + "unit": "kilos", + "value": 500 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 14.61 + }, + "avgSpeed": { + "unit": "kmsperhour", + "value": 7.2 + }, + "harvestProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 30 + }, + "totalYield": { + "unit": "kilos", + "value": 900 + }, + "avgYield": { + "unit": "kilosperacre", + "value": 30 + }, + "totalWetMass": { + "unit": "kilos", + "value": 300 + }, + "avgWetMass": { + "unit": "kilosperacre", + "value": 10 + }, + "avgMoisture": { + "unit": "percent", + "value": 16.4 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-02-27T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{partyId}}/harvestData?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ImageProcessing_CreateRasterizeJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ImageProcessing_CreateRasterizeJob.json new file mode 100644 index 000000000000..da5e6af21f4f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ImageProcessing_CreateRasterizeJob.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-11-01-preview", + "job": { + "partyId": "string", + "shapefileAttachmentId": "string", + "shapefileColumnNames": [ + "string" + ] + } + }, + "responses": { + "202": { + "body": { + "partyId": "string", + "shapefileAttachmentId": "string", + "shapefileColumnNames": [ + "string" + ], + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ImageProcessing_GetRasterizeJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ImageProcessing_GetRasterizeJob.json new file mode 100644 index 000000000000..b4e8b7e317f9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ImageProcessing_GetRasterizeJob.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "partyId": "string", + "shapefileAttachmentId": "string", + "shapefileColumnNames": [ + "string" + ], + "id": "string", + "status": "string", + "durationInSeconds": 15, + "message": "string", + "createdDateTime": "2021-05-03T08:51:04.744Z", + "lastActionDateTime": "2021-05-03T08:51:04.744Z", + "startTime": "2021-05-03T08:51:04.744Z", + "endTime": "2021-05-03T08:51:04.744Z", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_CreateOrUpdate.json new file mode 100644 index 000000000000..ea07eaf329c8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "partyId": "pjparty", + "modelId": "modelId", + "insightId": "insightId", + "insightAttachmentId": "insightAttachmentId", + "resourceId": "farmId", + "resourceType": "Farm", + "api-version": "2023-11-01-preview", + "body": { + "insightId": "insightId", + "resourceId": "farmId", + "resourceType": "Farm", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + }, + "responses": { + "200": { + "body": { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + }, + "201": { + "body": { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_Delete.json new file mode 100644 index 000000000000..b9f2639430a2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "partyId": "PARTY123", + "modelId": "modelId", + "insightAttachmentId": "insightAttachmentId", + "resourceId": "resourceId", + "resourceType": "Farm", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_Download.json new file mode 100644 index 000000000000..b911ebe3d00a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_Download.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightAttachmentId": "ATTACHMENT123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_Get.json new file mode 100644 index 000000000000..06c278380b41 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightAttachmentId": "insightAttachmentId" + }, + "responses": { + "200": { + "body": { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_ListByPartyIdModelIdAndResource.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_ListByPartyIdModelIdAndResource.json new file mode 100644 index 000000000000..b35557a6fd76 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/InsightAttachments_ListByPartyIdModelIdAndResource.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "insightAttachmentId", + "insightId": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "status": "insightAttachmentStatus", + "name": "insightAttachmentName", + "description": "insightAttachmentDescription" + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insight-attachments?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..e916ea840d7c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_CreateCascadeDeleteJob.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightId": "insightId", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_CreateOrUpdate.json new file mode 100644 index 000000000000..1e764f64e0c4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "partyId": "pjparty", + "modelId": "BiomassModelId", + "insightId": "insightId", + "resourceId": "farmId", + "resourceType": "Farm", + "api-version": "2023-11-01-preview", + "insightData": { + "modelVersion": "1.0", + "insightStartDateTime": "2021-07-26T09:31:54.043Z", + "insightEndDateTime": "2021-07-26T09:31:54.043Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-11-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-11-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_Delete.json new file mode 100644 index 000000000000..31de52da28fa --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "partyId": "PARTY123", + "modelId": "modelId", + "insightId": "insightId", + "resourceId": "resourceId", + "resourceType": "Farm", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_Get.json new file mode 100644 index 000000000000..a16d65c310ec --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "insightId": "insightId" + }, + "responses": { + "200": { + "body": { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "attachmentsLink": "https://contosa.farmbeats.azure.net/party/pjparty/insight-attachments/insightId?api-version=2023-11-01-preview&modelId=modelId&resourceType=Farm&resourceId=farmId", + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..f3789b3e0b22 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_ListByPartyIdModelIdAndResource.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_ListByPartyIdModelIdAndResource.json new file mode 100644 index 000000000000..5da9cda58005 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Insights_ListByPartyIdModelIdAndResource.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "insightId", + "partyId": "pjparty", + "resourceId": "farmId", + "resourceType": "Farm", + "modelId": "modelId", + "modelVersion": "1.0", + "insightStartDateTime": "2021-07-26T09:31:54Z", + "insightEndDateTime": "2021-07-26T09:31:54Z", + "measurements": { + "additionalPropKey1": { + "unit": "15m/s", + "value": 0 + } + }, + "createdDateTime": "2021-07-26T11:19:11Z", + "modifiedDateTime": "2021-07-26T11:19:11Z", + "eTag": "00000000-0000-0000-8210-0ef9229601d7", + "name": "insightName", + "description": "insightDescription", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/insights?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..eb94717eb33e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "managementZoneId": "MANAGEMENTZONE123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "MANAGEMENTZONE123", + "resourceType": "managementzone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_CreateOrUpdate.json new file mode 100644 index 000000000000..e505bca161f0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "partyId": "PARTY123", + "managementZoneId": "ManagementZone123", + "api-version": "2023-11-01-preview", + "managementZone": { + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "status": "Active", + "name": "John Smith's ManagementZone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_Delete.json new file mode 100644 index 000000000000..4ef792aefcbf --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "managementZoneId": "ManagementZone123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_Get.json new file mode 100644 index 000000000000..93aaf0ad2790 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "managementZoneId": "ManagementZone123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..48d73bd36457 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "MANAGEMENTZONE123", + "resourceType": "managementzone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_List.json new file mode 100644 index 000000000000..8e741e8bae3c --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/management-zones?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_ListByPartyId.json new file mode 100644 index 000000000000..589ff8eddd69 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/ManagementZones_ListByPartyId.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "type": "Nutrient rich", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/management-zones?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_CreateOrUpdate.json new file mode 100644 index 000000000000..5364f0e7e254 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_CreateOrUpdate.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "partyId": "PARTY123", + "nutrientAnalysisId": "NutrientAnalysis123", + "api-version": "2023-11-01-preview", + "nutrientAnalysis": { + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "status": "Active", + "name": "John Smith's Nutrient Analysis", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_Delete.json new file mode 100644 index 000000000000..7f0d04251136 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "nutrientAnalysisId": "NutrientAnalysis123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_Get.json new file mode 100644 index 000000000000..09786e3c7d1b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "nutrientAnalysisId": "NutrientAnalysis123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_List.json new file mode 100644 index 000000000000..f9820b6e3a30 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_List.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's NutrientAnalysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/nutrient-analyses?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_ListByPartyId.json new file mode 100644 index 000000000000..c2a23afc7a53 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/NutrientAnalyses_ListByPartyId.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "id": "ManagementZone123", + "parentId": "ParentId", + "parentType": "PlantTissueAnalysis", + "unit": "Unit", + "value": 250, + "referenceValueLow": 22, + "referenceValueHigh": 33, + "classification": "Classification", + "recommendation": "Advice", + "products": [ + { + "rate": "Rate", + "instruction": "Instruction", + "product": "product" + } + ], + "name": "John Smith's Nutrient analysis", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/nutrient-analyses?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..d24dda5be73e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_CreateCascadeDeleteJob.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "oauthProviderId": "OAuthProvider123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "oauthProviderId": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'oauthprovider' resource with id 'OAuthProvider123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_CreateOrUpdate.json new file mode 100644 index 000000000000..4ba09d32b192 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "oauthProviderId": "JOHNDEERE", + "api-version": "2023-11-01-preview", + "oauthProvider": { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "JOHNDEERE", + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + }, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-23T11:31:10Z", + "modifiedDateTime": "2021-04-23T11:31:10Z" + } + }, + "201": { + "body": { + "id": "JOHNDEERE", + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "name": "JOHNDEERE", + "description": "some description", + "properties": { + "orgId": "ORG123" + }, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-23T11:31:10Z", + "modifiedDateTime": "2021-04-23T11:31:10Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_Delete.json new file mode 100644 index 000000000000..37e4bbfa1b4b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "oauthProviderId": "JOHNDEERE", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_Get.json new file mode 100644 index 000000000000..d7302ebdaa52 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "oauthProviderId": "JOHNDEERE", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "id": "JOHNDEERE", + "eTag": "f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:27:37Z", + "modifiedDateTime": "2021-04-22T18:27:37Z", + "name": "JD Integration", + "description": "Oauth Flow", + "properties": { + "Party": "123" + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..469641956bba --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_GetCascadeDeleteJobDetails.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "oauthProviderId": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_List.json new file mode 100644 index 000000000000..af449721d89f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthProviders_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "appId": "appId", + "appSecret": "appSecret", + "apiKey": "apiKey", + "isProductionApp": false, + "id": "JOHNDEERE", + "eTag": "f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:27:37Z", + "modifiedDateTime": "2021-04-22T18:27:37Z", + "name": "JD Integration", + "description": "Oauth Flow", + "properties": { + "Party": "123" + } + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..82f80a2b26c0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "oauthProviderId": "OAUTHPROVIDER123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'oauthtokeninfo' resource with id 'OAUTHPROVIDER123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "OAUTHPROVIDER123", + "resourceType": "oauthtokeninfo" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..646390274b28 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "OAUTHPROVIDER123", + "resourceType": "oauthtokeninfo" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_GetOAuthConnectionLink.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_GetOAuthConnectionLink.json new file mode 100644 index 000000000000..9ad15ce81ef8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_GetOAuthConnectionLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "oauthConnectRequest": { + "partyId": "PARTY123", + "oAuthProviderId": "JOHNDEERE", + "userRedirectLink": "https://docs.microsoft.com", + "userRedirectState": "code" + } + }, + "responses": { + "200": { + "body": "Connection string" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_List.json new file mode 100644 index 000000000000..8ee19fe8c7d6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/OAuthTokens_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "PARTY123", + "authProviderId": "JOHNDEERE", + "isValid": true, + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e", + "createdDateTime": "2021-04-22T18:49:25Z", + "modifiedDateTime": "2021-04-22T18:49:25Z" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..d7e187776329 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_CreateCascadeDeleteJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "party" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_CreateOrUpdate.json new file mode 100644 index 000000000000..5b6d49587e28 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-11-01-preview", + "party": { + "status": "Active", + "name": "John Smith", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_Delete.json new file mode 100644 index 000000000000..4e37a898f0ac --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_GeoOverlap.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_GeoOverlap.json new file mode 100644 index 000000000000..1eaa57bb3b8f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_GeoOverlap.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "overlapResources": { + "resources": [ + { + "partyId": "PARTY123", + "resourceType": "Field", + "resourceId": "FIELD123" + }, + { + "partyId": "PARTY456", + "resourceType": "Field", + "resourceId": "FIELD456" + } + ] + }, + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "resources": [ + { + "partyId": "PARTY123", + "resourceType": "Field", + "resourceId": "FIELD123", + "resourceArea": 35 + }, + { + "partyId": "PARTY456", + "resourceType": "Field", + "resourceId": "FIELD456", + "resourceArea": 25 + } + ], + "overlappingArea": 10 + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_Get.json new file mode 100644 index 000000000000..f42e2aa4b105 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123" + }, + "responses": { + "200": { + "body": { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..c295f00156cf --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PARTY123", + "resourceType": "party" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_List.json new file mode 100644 index 000000000000..802e1d61035f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Parties_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PARTY123", + "name": "John Smith", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..cabc6b95b6b0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantTissueAnalysisId": "PlantTissueAnalysis123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'planttissueanalysis' resource with id 'PlantTissueAnalysis123' and partyId 'PARTY123'.", + "createdDateTime": "2021-07-19T11:31:20Z", + "lastActionDateTime": "2021-07-19T11:31:34Z", + "startTime": "2021-07-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantTissueAnalysis123", + "resourceType": "planttissueanalysis" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_CreateOrUpdate.json new file mode 100644 index 000000000000..f9c2c2ec9110 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_CreateOrUpdate.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantTissueAnalysisId": "PLANTTISSUEANALYSIS123", + "api-version": "2023-11-01-preview", + "plantTissueAnalysis": { + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2022-05-11T07:00:10Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "status": "Active", + "name": "John Smith's ManagementZone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_Delete.json new file mode 100644 index 000000000000..ac634dd1bbc3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantTissueAnalysisId": "PLANTTISSUEANALYSES123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_Get.json new file mode 100644 index 000000000000..7a447aaccda9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "plantTissueAnalysisId": "PLANTTISSUEANALYSES123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "cropId": "Crop123", + "fieldId": "Field123", + "plantingDateTime": "2021-04-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..11751b5c512d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-07-19T11:31:20Z", + "lastActionDateTime": "2021-07-19T11:31:34Z", + "startTime": "2021-07-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantTissueAnalysis123", + "resourceType": "planttissueanalysis" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_Search.json new file mode 100644 index 000000000000..792ca75da5a2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantTissueAnalyses_Search.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "maxPageSize": 50, + "searchPlantTissueAnalysisQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "FARMER123", + "id": "PLANTTISSUEANALYSIS123", + "seasonId": "Season123", + "fieldId": "Field123", + "plantingDateTime": "2021-03-21T06:49:30Z", + "plantPart": "PlantPart", + "plantPosition": "PlantPosition", + "plantAppearance": "PlantAppearance", + "sampleCollectionCondition": "SampleCollectionCondition", + "sampleCollectionDateTime": "2021-04-21T06:49:30Z", + "sampleReceivedDateTime": "2021-04-22T06:49:30Z", + "sampleTestResultDateTime": "2021-04-23T06:49:30Z", + "labDetails": { + "code": "LabId", + "name": "Name", + "address": "Address", + "description": "Description" + }, + "name": "John Smith's ManagementZone", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/plant-tissue-analyses?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..0bba8ded8c12 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "plantingDataId": "PlantingData123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationplantingdata' resource with id 'PlantingData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantingData123", + "resourceType": "farmoperationplantingdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_CreateOrUpdate.json new file mode 100644 index 000000000000..31904de3ae7f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_CreateOrUpdate.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "plantingDataId": "PLANTINGOP123", + "plantingData": { + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_Delete.json new file mode 100644 index 000000000000..9f46e1c0e2a3 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "plantingDataId": "PLANTINGOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_Get.json new file mode 100644 index 000000000000..16c8f82fa263 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "plantingDataId": "PLANTINGOP123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..60ac640178c4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "PlantingData123", + "resourceType": "farmoperationplantingdata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_Search.json new file mode 100644 index 000000000000..da3362eb0ba1 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PlantingData_Search.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "maxPageSize": 50, + "searchFarmOperationQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "FARMER123", + "id": "PLANTINGOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "avgPlantingRate": { + "unit": "seedsperacre", + "value": 30 + }, + "area": { + "unit": "acre", + "value": 30 + }, + "totalMaterial": { + "unit": "seeds", + "value": 758814 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 25293 + }, + "plantingProductDetails": [ + { + "productName": "VAR1", + "area": { + "unit": "acre", + "value": 20 + }, + "totalMaterial": { + "unit": "seeds", + "value": 389214 + }, + "avgMaterial": { + "unit": "seedsperacre", + "value": 19460 + } + } + ], + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-02-27T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{partyId}}/plantingData?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..b89c28717c05 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTIONMAP123", + "resourceType": "prescriptionmap" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_CreateOrUpdate.json new file mode 100644 index 000000000000..6af14ef2bc04 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_CreateOrUpdate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123", + "api-version": "2023-11-01-preview", + "prescriptionMap": { + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "status": "Active", + "name": "John Smith's Prescription map", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_Delete.json new file mode 100644 index 000000000000..b3dd3ff65a3d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_Get.json new file mode 100644 index 000000000000..099cd1d995d0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTIONMAP123" + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..06686e60fefa --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTIONMAP123", + "resourceType": "prescriptionmap" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_List.json new file mode 100644 index 000000000000..9a13e5c7fbd9 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/prescription-maps?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_ListByPartyId.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_ListByPartyId.json new file mode 100644 index 000000000000..69781cb55875 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/PrescriptionMaps_ListByPartyId.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "partyId": "PARTY123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "PRESCRIPTIONMAP123", + "partyId": "PARTY123", + "fieldId": "FIELD123", + "seasonId": "SEASON123", + "cropId": "CROP123", + "type": "Planting", + "name": "John Smith's Prescription map", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/prescription-maps?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..23348baf1bbf --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTION123", + "resourceType": "prescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_CreateOrUpdate.json new file mode 100644 index 000000000000..c73af95493b5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_CreateOrUpdate.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123", + "api-version": "2023-11-01-preview", + "prescription": { + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "status": "Active", + "name": "John Smith's Prescription", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_Delete.json new file mode 100644 index 000000000000..4e8eb9dfac06 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_Get.json new file mode 100644 index 000000000000..d70e548acbae --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "prescriptionId": "PRESCRIPTION123" + }, + "responses": { + "200": { + "body": { + "id": "PRESCRIPTION123", + "partyId": "PARTY123", + "prescriptionMapId": "PRESCRIPTINMAP123", + "productCode": "PRODUCTCODE123", + "productName": "Some name", + "type": "Planting", + "measurements": { + "total material": { + "value": 12, + "unit": "pounds" + }, + "rate": { + "value": 13, + "unit": "Km/hr" + } + }, + "name": "John Smith's Prescription", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..a2f39fb1e0c0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "PRESCRIPTION123", + "resourceType": "prescription" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_Search.json new file mode 100644 index 000000000000..6d7fc9a6289d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Prescriptions_Search.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "maxPageSize": 50, + "searchPrescriptionQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "FARMER123", + "id": "Prescription123", + "prescriptionMapId": "PrescriptionMap123", + "type": "Nutrient rich", + "status": "Active", + "source": "Agronomist", + "name": "John Smith", + "description": "Some description", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/zones?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json new file mode 100644 index 000000000000..c0e09fc3a189 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_CreateSatelliteDataIngestionJob.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-11-01-preview", + "job": { + "associatedResource": { + "type": "Field", + "id": "Field123" + }, + "partyId": "PARTY123", + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "SentinelHub", + "credentials": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + }, + "collection": "sentinel-2-l2a", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "data": { + "imageFormats": [ + "Tif" + ], + "imageNames": [ + "NDVI" + ], + "imageResolutions": [ + 10.0 + ] + }, + "properties": { + "Region": "Asia" + } + } + }, + "responses": { + "202": { + "body": { + "durationInSeconds": 12.4, + "id": "satellite-job", + "status": "Created", + "message": "Created job 'satellite-job' to fetch satellite data for boundary 'BOUNDARY123' for startDate '01/01/2019 00:00:00' and endDate '03/30/2019 00:00:00' (both inclusive)", + "createdDateTime": "2021-04-16T07:56:05Z", + "lastActionDateTime": "2021-04-16T07:56:05Z", + "startDateTime": "2021-04-16T07:56:05Z", + "endDateTime": "2021-04-16T07:56:05Z", + "partyId": "PARTY123", + "associatedResource": { + "type": "Field", + "id": "Field123" + }, + "credentials": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "string", + "keyName": "string", + "keyVersion": "string" + } + }, + "collection": "sentinel-2-l2a", + "provider": "SentinelHub", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "properties": { + "Region": "Asia" + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_Download.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_Download.json new file mode 100644 index 000000000000..98772c6a9e42 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_Download.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "filePath": "https://filePath", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json new file mode 100644 index 000000000000..36dcba28f1a0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_GetSatelliteDataIngestionJobDetails.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "jobId": "JOB123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "durationInSeconds": 12.4, + "id": "satellite-job", + "status": "Succeeded", + "message": "Satellite data is available for 73 days from provider in the requested date range. Successfully fetched data for 73 days.", + "createdDateTime": "2021-04-16T08:24:50Z", + "lastActionDateTime": "2021-04-16T08:24:50Z", + "startTime": "2021-04-16T08:24:50Z", + "endTime": "2021-04-16T08:24:50Z", + "name": "North Farm 2019 satellite imagery", + "description": "Test job", + "properties": { + "Region": "Asia" + }, + "associatedResource": { + "type": "Field", + "id": "Field123" + }, + "partyId": "PARTY123", + "credentials": { + "kind": "OAuthClientCredentials", + "clientId": "string", + "clientSecret": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + }, + "startDateTime": "2020-04-16T10:14:12Z", + "endDateTime": "2021-04-16T10:14:12Z", + "provider": "Microsoft", + "collection": "sentinel-2-l2a", + "data": { + "imageFormats": [ + "Tif" + ], + "imageNames": [ + "NDVI" + ], + "imageResolutions": [ + 10.0 + ] + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_List.json new file mode 100644 index 000000000000..d13d48d7f89b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_List.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "provider": "SentinelHub", + "partyId": "PARTY123", + "associatedResourceId": "FIELD123", + "associatedResourceType": "Field", + "collection": "Sentinel-2-L2A", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "400e200f-ccc4-0cea-c120-3fdc6a41f99f", + "sceneDateTime": "2019-01-27T00:00:00Z", + "partyId": "PARTY123", + "associatedResource": { + "type": "Field", + "id": "Field123" + }, + "provider": "Microsoft", + "collection": "sentinel-2-l2a", + "cloudCoverPercentage": 67.2, + "darkPixelPercentage": 2.4, + "imageFormat": "TIF", + "imageFiles": [ + { + "name": "B08", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b08_10.tif" + }, + { + "name": "B03", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b03_10.tif" + }, + { + "name": "B11", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b11_10.tif" + }, + { + "name": "SNW", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/snw_10.tif" + }, + { + "name": "B05", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b05_10.tif" + }, + { + "name": "B06", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b06_10.tif" + }, + { + "name": "dataMask", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/datamask_10.tif" + }, + { + "name": "B07", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b07_10.tif" + }, + { + "name": "CLP", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/clp_10.tif" + }, + { + "name": "NDVI", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/ndvi_10.tif" + }, + { + "name": "SCL", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/scl_10.tif" + }, + { + "name": "B09", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b09_10.tif" + }, + { + "name": "B01", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b01_10.tif" + }, + { + "name": "NDWI", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/ndwi_10.tif" + }, + { + "name": "AOT", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/aot_10.tif" + }, + { + "name": "CLD", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/cld_10.tif" + }, + { + "name": "CLM", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/clm_10.tif" + }, + { + "name": "B02", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b02_10.tif" + }, + { + "name": "B04", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b04_10.tif" + }, + { + "name": "B8A", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b8a_10.tif" + }, + { + "name": "EVI", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/evi_10.tif" + }, + { + "name": "B12", + "resolution": 10.0, + "fileLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/downloadFiles?api-version=2023-11-01-preview& filePath=microsoft/sentinel-2-l2a/PARTY123/BOUNDARY123/2019-01-27/00-00-00/b12_10.tif" + } + ] + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/scenes?provider=Microsoft&partyId=PARTY123&api-version=2020-10-16-preview&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1PTnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAdOfBwAAAAAA7Z8HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_SearchItems.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_SearchItems.json new file mode 100644 index 000000000000..12559e2cb5b0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Scenes_SearchItems.json @@ -0,0 +1,438 @@ +{ + "parameters": { + "collectionId": "sentinel-2-l2a", + "api-version": "2023-11-01-preview", + "searchItemsQuery": { + "startDateTime": "2022-01-26T14:53:23.825Z", + "endDateTime": "2023-01-26T14:53:23.825Z", + "intersects": { + "type": "Polygon", + "coordinates": [ + [ + [ + 7.662878883920398, + 47.845905986476225 + ], + [ + 7.687601396600625, + 46.85818510350441 + ], + [ + 9.12804406196848, + 46.86563725992561 + ], + [ + 9.130456971517189, + 47.85361872819965 + ], + [ + 7.662878883920398, + 47.845905986476225 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "items": [ + { + "stacVersion": "0.9.0", + "stacExtensions": [ + "eo", + "projection" + ], + "id": "S2B_MSIL2A_20230121T102239_N0509_R065_T32UMU_20230121T113700", + "type": "Feature", + "geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:OGC::CRS84" + } + }, + "coordinates": [ + [ + [ + [ + 8.463630109874195, + 48.75175579972667 + ], + [ + 8.09718328627216, + 47.761624720018254 + ], + [ + 9.130235487170578, + 47.76510167563715 + ], + [ + 9.13276898152643, + 48.75292752793247 + ], + [ + 8.463630109874195, + 48.75175579972667 + ] + ] + ] + ] + }, + "bbox": [ + 8.09718328627216, + 47.761624720018254, + 9.13276898152643, + 48.75292752793247 + ], + "properties": { + "datetime": "2023-01-21T10:27:32Z", + "platform": "sentinel-2b", + "instruments": [ + "msi" + ], + "constellation": "sentinel-2", + "eo:gsd": 10, + "eo:cloud_cover": 80.46, + "eo:bands": [ + { + "name": "B01", + "common_name": "coastal", + "center_wavelength": 0.4427, + "full_width_half_max": 0.021 + }, + { + "name": "B02", + "common_name": "blue", + "center_wavelength": 0.4924, + "full_width_half_max": 0.066 + }, + { + "name": "B03", + "common_name": "green", + "center_wavelength": 0.5598, + "full_width_half_max": 0.036 + }, + { + "name": "B04", + "common_name": "red", + "center_wavelength": 0.6646, + "full_width_half_max": 0.031 + }, + { + "name": "B05", + "center_wavelength": 0.7041, + "full_width_half_max": 0.015 + }, + { + "name": "B06", + "center_wavelength": 0.7405, + "full_width_half_max": 0.015 + }, + { + "name": "B07", + "center_wavelength": 0.7828, + "full_width_half_max": 0.02 + }, + { + "name": "B08", + "common_name": "nir", + "center_wavelength": 0.8328, + "full_width_half_max": 0.106 + }, + { + "name": "B8A", + "common_name": "nir08", + "center_wavelength": 0.8647, + "full_width_half_max": 0.021 + }, + { + "name": "B09", + "common_name": "nir09", + "center_wavelength": 0.9451, + "full_width_half_max": 0.02 + }, + { + "name": "B11", + "common_name": "swir16", + "center_wavelength": 1.6137, + "full_width_half_max": 0.091 + }, + { + "name": "B12", + "common_name": "swir22", + "center_wavelength": 2.2024, + "full_width_half_max": 0.175 + } + ], + "proj:epsg": 32632, + "proj:bbox": [ + 399960, + 5290200, + 509760, + 5400000 + ], + "proj:geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:EPSG::32632" + } + }, + "coordinates": [ + [ + [ + [ + 460574.0276522319, + 5399999.00024835 + ], + [ + 432344.5418597979, + 5290201.00021934 + ], + [ + 509758.99999999994, + 5290201.000219454 + ], + [ + 509759, + 5399999.000248388 + ], + [ + 460574.0276522319, + 5399999.00024835 + ] + ] + ] + ] + } + }, + "links": [ + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a/items/S2B_MSIL2A_20230121T102239_N0509_R065_T32UMU_20230121T113700", + "rel": "self", + "type": "application/json" + }, + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a", + "rel": "parent" + }, + { + "href": "https://scihub.copernicus.eu/dhus/odata/v1/Products('ece4b170-065b-4d3c-a005-9c20b8f383fe')/$value", + "rel": "derived_from", + "title": "scihub download" + } + ], + "assets": { + "thumbnail": { + "href": "https://roda.sentinel-hub.com/sentinel-s2-l1c/tiles/32/T/MT/2023/1/4/0/preview.jpg", + "title": "thumbnail", + "type": "image/png" + } + } + }, + { + "stacVersion": "0.9.0", + "stacExtensions": [ + "eo", + "projection" + ], + "id": "S2B_MSIL2A_20230121T102239_N0509_R065_T32UNU_20230121T113700", + "type": "Feature", + "geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:OGC::CRS84" + } + }, + "coordinates": [ + [ + [ + [ + 8.999741508947052, + 48.753004006975516 + ], + [ + 8.999746441483957, + 47.76517556280485 + ], + [ + 10.46477378099951, + 47.7558278091967 + ], + [ + 10.493255611543965, + 48.743328406398774 + ], + [ + 8.999741508947052, + 48.753004006975516 + ] + ] + ] + ] + }, + "bbox": [ + 8.999741508947052, + 47.7558278091967, + 10.493255611543965, + 48.753004006975516 + ], + "properties": { + "datetime": "2023-01-21T10:27:28Z", + "platform": "sentinel-2b", + "instruments": [ + "msi" + ], + "constellation": "sentinel-2", + "eo:gsd": 10, + "eo:cloud_cover": 95.46, + "eo:bands": [ + { + "name": "B01", + "common_name": "coastal", + "center_wavelength": 0.4427, + "full_width_half_max": 0.021 + }, + { + "name": "B02", + "common_name": "blue", + "center_wavelength": 0.4924, + "full_width_half_max": 0.066 + }, + { + "name": "B03", + "common_name": "green", + "center_wavelength": 0.5598, + "full_width_half_max": 0.036 + }, + { + "name": "B04", + "common_name": "red", + "center_wavelength": 0.6646, + "full_width_half_max": 0.031 + }, + { + "name": "B05", + "center_wavelength": 0.7041, + "full_width_half_max": 0.015 + }, + { + "name": "B06", + "center_wavelength": 0.7405, + "full_width_half_max": 0.015 + }, + { + "name": "B07", + "center_wavelength": 0.7828, + "full_width_half_max": 0.02 + }, + { + "name": "B08", + "common_name": "nir", + "center_wavelength": 0.8328, + "full_width_half_max": 0.106 + }, + { + "name": "B8A", + "common_name": "nir08", + "center_wavelength": 0.8647, + "full_width_half_max": 0.021 + }, + { + "name": "B09", + "common_name": "nir09", + "center_wavelength": 0.9451, + "full_width_half_max": 0.02 + }, + { + "name": "B11", + "common_name": "swir16", + "center_wavelength": 1.6137, + "full_width_half_max": 0.091 + }, + { + "name": "B12", + "common_name": "swir22", + "center_wavelength": 2.2024, + "full_width_half_max": 0.175 + } + ], + "proj:epsg": 32632, + "proj:bbox": [ + 499980, + 5290200, + 609780, + 5400000 + ], + "proj:geometry": { + "type": "MultiPolygon", + "crs": { + "type": "name", + "properties": { + "name": "urn:ogc:def:crs:EPSG::32632" + } + }, + "coordinates": [ + [ + [ + [ + 499981, + 5399999.000248392 + ], + [ + 499981, + 5290201.000219455 + ], + [ + 609779.0000024929, + 5290201.000219092 + ], + [ + 609779.0000028561, + 5399999.000247997 + ], + [ + 499981, + 5399999.000248392 + ] + ] + ] + ] + } + }, + "links": [ + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a/items/S2B_MSIL2A_20230121T102239_N0509_R065_T32UNU_20230121T113700", + "rel": "self", + "type": "application/json" + }, + { + "href": "https://services.sentinel-hub.com/api/v1/catalog/collections/sentinel-2-l2a", + "rel": "parent" + }, + { + "href": "https://scihub.copernicus.eu/dhus/odata/v1/Products('986643df-22f1-4c6b-be20-7db66ecbc699')/$value", + "rel": "derived_from", + "title": "scihub download" + } + ], + "assets": { + "thumbnail": { + "href": "https://roda.sentinel-hub.com/sentinel-s2-l1c/tiles/32/T/MT/2023/1/4/0/preview.jpg", + "title": "thumbnail", + "type": "image/png" + } + } + } + ], + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/scenes/stac-collection/{{collectionId}}:search?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..4ee1d0615da6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "SEASONALFIELD123", + "resourceType": "seasonalfield" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_CreateOrUpdate.json new file mode 100644 index 000000000000..56b4c74d6838 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_CreateOrUpdate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-11-01-preview", + "seasonalField": { + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_Delete.json new file mode 100644 index 000000000000..4a2e6c0baf1f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_Get.json new file mode 100644 index 000000000000..8d4346e38bcf --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "partyId": "PARTY123", + "seasonalFieldId": "SEASONALFIELD123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "SEASONALFIELD123", + "partyId": "PARTY123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..d9a3b88877f0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "SEASONALFIELD123", + "resourceType": "seasonalfield" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_Search.json new file mode 100644 index 000000000000..a01e888fe063 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SeasonalFields_Search.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "maxPageSize": 50, + "searchSeasonalFieldQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "SEASONALFIELD123", + "partyId": "FARMER123", + "farmId": "FARM123", + "fieldId": "FIELD123", + "seasonId": "WINTER_WHEAT_2021", + "cropId": "WHEAT", + "name": "John Smith's Seasonal Field", + "status": "Active", + "description": "Some description", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_CreateOrUpdate.json new file mode 100644 index 000000000000..ccfa23107b35 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_CreateOrUpdate.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "seasonId": "SEASON123", + "season": { + "startDateTime": "2021-04-22T17:56:28Z", + "endDateTime": "2021-04-22T17:56:28Z", + "year": 2012, + "status": "Active", + "name": "John Smith's Season", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + } + } + }, + "responses": { + "200": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_Delete.json new file mode 100644 index 000000000000..672f3a61c368 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "seasonId": "SEASON123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_Get.json new file mode 100644 index 000000000000..3c018554c1bd --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "seasonId": "SEASON123" + }, + "responses": { + "200": { + "body": { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_List.json new file mode 100644 index 000000000000..1b8887574543 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Seasons_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "startDateTime": "2021-04-22T17:50:26Z", + "endDateTime": "2021-04-22T17:50:26Z", + "year": 2012, + "id": "SEASON123", + "name": "John Smith's Season", + "status": "Active", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes", + "RetailerId": "Retailer123" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_CreateOrUpdate.json new file mode 100644 index 000000000000..66fa54e669d0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_CreateOrUpdate.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorDataModelId": "sdm124", + "api-version": "2023-11-01-preview", + "sensorDataModelObject": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "status": "new", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:42Z", + "eTag": "040161a2-0000-0700-0000-61ee435a0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:15Z", + "eTag": "040158a0-0000-0700-0000-61ee433f0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_Delete.json new file mode 100644 index 000000000000..869a06c4c220 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorDataModelId": "ddm124", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_Get.json new file mode 100644 index 000000000000..db6bba449467 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "sp1", + "sensorDataModelId": "sdm124" + }, + "responses": { + "200": { + "body": { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:42Z", + "eTag": "040161a2-0000-0700-0000-61ee435a0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_List.json new file mode 100644 index 000000000000..cfbfdf9ddc84 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorDataModels_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Sensor", + "manufacturer": "Some sensor manufacturer", + "productCode": "soil m", + "measures": { + "soilMoisture": { + "description": "measures soil moisture", + "dataType": "Bool", + "type": "sm", + "unit": "none", + "properties": { + "abc": "def", + "elevation": 5 + } + } + }, + "sensorPartnerId": "sp1", + "id": "sdm124", + "status": "new", + "createdDateTime": "2022-01-24T06:12:15Z", + "modifiedDateTime": "2022-01-24T06:12:42Z", + "eTag": "040161a2-0000-0700-0000-61ee435a0000", + "name": "my sdm for soil moisture", + "description": "description goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/sensor-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorEvents_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorEvents_List.json new file mode 100644 index 000000000000..cf4f96bc8058 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorEvents_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorId": "S124", + "sensorPartnerId": "Davis", + "startDateTime": "2018-01-01T00:00:43Z", + "endDateTime": "2019-01-01T00:00:43Z", + "excludeDuplicateEvents": true + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "prbhad-party", + "eventDateTime": "2018-01-01T00:30:00Z", + "ingestionDateTime": "2021-09-20T05:56:09Z", + "measures": { + "soil_moisture": { + "unit": "m", + "value": 30.1 + } + } + }, + { + "partyId": "prbhad-party", + "eventDateTime": "2018-01-01T00:31:00Z", + "ingestionDateTime": "2021-09-20T05:56:09Z", + "measures": { + "soil_moisture": { + "unit": "m", + "value": 31.1 + } + } + } + ] + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_CreateOrUpdate.json new file mode 100644 index 000000000000..2bb1ed87a76d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_CreateOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "sensorMappingId": "sm124", + "api-version": "2023-11-01-preview", + "sensorMappingObject": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "associatedResource": { + "type": "Field", + "id": "Field123" + }, + "status": "sensor map created", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "associatedResource": { + "type": "Field", + "id": "Field123" + }, + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:41:05Z", + "eTag": "0501f236-0000-0700-0000-61ee4a010000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "associatedResource": { + "type": "Field", + "id": "Field123" + }, + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:40:48Z", + "eTag": "05018f35-0000-0700-0000-61ee49f00000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_Delete.json new file mode 100644 index 000000000000..89989c83a8da --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_Delete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "sensorMappingId": "sm124", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_Get.json new file mode 100644 index 000000000000..19a9ff99ad82 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorMappingId": "sm124" + }, + "responses": { + "200": { + "body": { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "associatedResource": { + "type": "Field", + "id": "Field123" + }, + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:41:05Z", + "eTag": "0501f236-0000-0700-0000-61ee4a010000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_List.json new file mode 100644 index 000000000000..8ed9beeb6ce6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorMappings_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sensorId": "s124", + "sensorPartnerId": "sp1", + "partyId": "aksaxena-party", + "associatedResource": { + "type": "Field", + "id": "Field123" + }, + "id": "sm124", + "status": "sensor map created", + "createdDateTime": "2022-01-24T06:40:48Z", + "modifiedDateTime": "2022-01-24T06:41:05Z", + "eTag": "0501f236-0000-0700-0000-61ee4a010000", + "name": "my new sensor map", + "description": "description for mapping", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/sensor-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_CheckConsent.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_CheckConsent.json new file mode 100644 index 000000000000..95c476e8386d --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_CheckConsent.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123", + "key": "CuDBfxEiFdTJFk40MNVMO22zvLBG7CA8", + "body": {} + }, + "responses": { + "200": { + "body": { + "consented": true, + "sensorPartnerId": "Davis", + "integrationId": "I123" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_CreateOrUpdate.json new file mode 100644 index 000000000000..b1dc0c8b24ee --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_CreateOrUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123", + "sensorPartnerIntegrationModel": { + "partyId": "prbhad-party", + "status": "string", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2021-11-22T05:07:14Z", + "modifiedDateTime": "2022-03-16T11:38:45Z", + "eTag": "73023740-0000-0700-0000-6231cc450000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2022-03-16T11:39:41Z", + "modifiedDateTime": "2022-03-16T11:39:41Z", + "eTag": "73023a53-0000-0700-0000-6231cc7d0000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_Delete.json new file mode 100644 index 000000000000..52045ec667c6 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "Davis", + "integrationId": "I123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_GenerateConsentLink.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_GenerateConsentLink.json new file mode 100644 index 000000000000..e639b707a795 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_GenerateConsentLink.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123", + "body": {} + }, + "responses": { + "200": { + "body": { + "consentLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/Davis/integrations/I123/:check-consent?key=CuDBfxEiFdTJFk40MNVMO22zvLBG7CA8&apiVersion=2023-11-01-preview", + "consentExpiryDateTime": "2022-03-17T11:56:40Z" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_Get.json new file mode 100644 index 000000000000..8107ec40dc14 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "Davis", + "integrationId": "I123" + }, + "responses": { + "200": { + "body": { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2021-11-22T05:07:14Z", + "modifiedDateTime": "2022-03-16T11:38:45Z", + "eTag": "73023740-0000-0700-0000-6231cc450000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_List.json new file mode 100644 index 000000000000..a127a8259151 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SensorPartnerIntegrations_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "sensorPartnerId": "Davis", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "integrationId": "I123", + "partyId": "prbhad-party", + "sensorPartnerId": "Davis", + "id": "I123", + "status": "string", + "createdDateTime": "2021-11-22T05:07:14Z", + "modifiedDateTime": "2022-01-04T11:17:08Z", + "eTag": "8900a6d8-0000-0700-0000-61d42cb40000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + }, + { + "integrationId": "I456", + "partyId": "prbhad-party2", + "sensorPartnerId": "Davis", + "id": "I456", + "status": "string", + "createdDateTime": "2022-01-12T10:33:54Z", + "modifiedDateTime": "2022-01-12T10:33:54Z", + "eTag": "8d014fe2-0000-0700-0000-61deae920000", + "name": "string", + "description": "string", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/Davis/integrations?maxPageSize=10&api-version=2023-11-01-preview&skipToken=W3sidG9rZW4iOiIrUklEOn4xQ1VyQU9zRU8zMXZucGdCQUFBQUFBPT0jUlQ6MSNUUkM6MTAjSVNWOjIjSUVPOjY1NTUxI1FDRjo0I0ZQQzpBZ0ppQm1JR1lnWUVBRytlRDRBPSIsInJhbmdlIjp7Im1pbiI6IiIsIm1heCI6IkZGIn19XQ" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_CreateOrUpdate.json new file mode 100644 index 000000000000..7fd5dc4e575f --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_CreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorId": "s124", + "api-version": "2023-11-01-preview", + "sensorDetails": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD 456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "status": "sm created", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "responses": { + "200": { + "body": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:05Z", + "eTag": "040139eb-0000-0700-0000-61ee46b90000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + }, + "201": { + "body": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:05Z", + "eTag": "040139eb-0000-0700-0000-61ee46b90000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_Delete.json new file mode 100644 index 000000000000..8a969759b7d8 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "sensorPartnerId": "sp1", + "sensorId": "s124", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_Get.json new file mode 100644 index 000000000000..8c5f7a3efbf0 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "sp1", + "sensorId": "s124" + }, + "responses": { + "200": { + "body": { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:31Z", + "eTag": "04019fed-0000-0700-0000-61ee46d30000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_GetConnectionString.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_GetConnectionString.json new file mode 100644 index 000000000000..02c8bbc79d19 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_GetConnectionString.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "sp1", + "sensorId": "s124", + "body": { + "connectionStringType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****", + "secondaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_List.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_List.json new file mode 100644 index 000000000000..de37f461099a --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_List.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "sp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sensorDataModelId": "sdm124", + "integrationId": "string", + "hardwareId": "SMHD-456", + "deviceId": "d124", + "type": "SM", + "location": { + "latitude": 23.5, + "longitude": 42.7 + }, + "port": { + "name": "measure", + "type": "digital" + }, + "sensorPartnerId": "sp1", + "id": "s124", + "status": "sm created", + "createdDateTime": "2022-01-24T06:27:05Z", + "modifiedDateTime": "2022-01-24T06:27:31Z", + "eTag": "04019fed-0000-0700-0000-61ee46d30000", + "name": "my new sm", + "description": "description for sensor goes here", + "properties": { + "key1": "value1", + "key2": 123.45 + } + } + ], + "skipToken": "skipToken", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/{{sensorPartnerId}}/device-data-models?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_RenewConnectionString.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_RenewConnectionString.json new file mode 100644 index 000000000000..4e6b44cffdb2 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Sensors_RenewConnectionString.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "sensorPartnerId": "sp1", + "sensorId": "s124", + "renewConnectionStringModel": { + "connectionStringType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****", + "secondaryDeviceConnectionString": "HostName=iothubName.azure-devices.net;DeviceId=809f4379-b4d3-de01-6425-f088de6645f5;SharedAccessKey=****" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SolutionInference_Cancel.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SolutionInference_Cancel.json new file mode 100644 index 000000000000..9448a40c34a4 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SolutionInference_Cancel.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "solutionId": "solution.solutionId", + "jobId": "jobId", + "requestPath": "/v1/resources/jobId", + "api-version": "2023-11-01-preview", + "solutionInferenceRequest": { + "requestPath": "string" + } + }, + "responses": { + "200": { + "body": { + "requestPath": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SolutionInference_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SolutionInference_CreateOrUpdate.json new file mode 100644 index 000000000000..d4c950a4b760 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SolutionInference_CreateOrUpdate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "solutionId": "solution.solutionId", + "jobId": "jobId", + "requestPath": "/v1/resources/jobId", + "api-version": "2023-11-01-preview", + "solutionInferenceRequest": { + "requestPath": "string" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "location" + }, + "body": { + "requestPath": "string" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SolutionInference_Fetch.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SolutionInference_Fetch.json new file mode 100644 index 000000000000..944a6dca1916 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/SolutionInference_Fetch.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "solutionId": "solution.solutionId", + "jobId": "jobId", + "requestPath": "/v1/resources/jobId", + "solutionInferenceRequest": { + "requestPath": "string" + }, + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "source": "Manual", + "name": "Application data for North Farm", + "description": "some description" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..41b5d1d58e81 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_CreateCascadeDeleteJob.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "partyId": "PARTY123", + "tillageDataId": "TillageData123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Waiting", + "message": "Created cascade delete job for 'farmoperationtillagedata' resource with id 'TillageData123' and partyId 'PARTY123'.", + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "TillageData123", + "resourceType": "farmoperationtillagedata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_CreateOrUpdate.json new file mode 100644 index 000000000000..c5853314b877 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_CreateOrUpdate.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "tillageDataId": "TILLAGEOP123", + "tillageData": { + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:12:12Z", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_Delete.json new file mode 100644 index 000000000000..6657eab18366 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "tillageDataId": "TILLAGEOP123" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_Get.json new file mode 100644 index 000000000000..605e412a411e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "tillageDataId": "TILLAGEOP123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Asia", + "CountyCode": 123 + }, + "createdDateTime": "2022-05-11T07:00:10.2750191Z", + "modifiedDateTime": "2022-05-11T07:00:10.2750191Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..8f575ed64189 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_GetCascadeDeleteJobDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "partyId": "PARTY123", + "resourceId": "TillageData123", + "resourceType": "farmoperationtillagedata" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_Search.json new file mode 100644 index 000000000000..4943a77ae250 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/TillageData_Search.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "maxPageSize": 50, + "searchFarmOperationQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "FARMER123", + "id": "TILLAGEOP123", + "source": "Manual", + "name": "Planting data for North Farm", + "description": "some description", + "status": "Active", + "operationStartDateTime": "2021-02-25T16:57:04Z", + "operationEndDateTime": "2021-02-27T10:13:06Z", + "operationModifiedDateTime": "2021-02-28T10:14:12Z", + "associatedResource": { + "type": "Field", + "id": "FieldId" + }, + "area": { + "unit": "acre", + "value": 30 + }, + "tillagePressure": { + "unit": "kg per sq cms", + "value": 950 + }, + "tillageDepth": { + "unit": "cms", + "value": 9.5 + }, + "properties": { + "Region": "Europe", + "CountyCode": 123 + }, + "createdDateTime": "2021-02-27T04:57:04Z", + "modifiedDateTime": "2021-03-08T18:22:07Z", + "eTag": "cb00a3ac-0000-0100-0000-601d21ec0000" + } + ], + "skipToken": "string", + "nextLink": "https:/{{resourceName}}.farmbeats.azure.net/farmers/{{partyId}}/plantingData?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7ehK8eAKzdo1MNnwcAAAAAAA%3d%3d%23RT%3a1%23TRC%3a10%23ISV%3a2%23IEO%3a65551%23FPC%3aAQ2fBwAAAAAAD58HAAAAAAA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/WeatherData_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/WeatherData_Get.json new file mode 100644 index 000000000000..e5f80347e4af --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/WeatherData_Get.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "weatherDataProviderRequest": { + "extensionId": "IBM.TWC", + "extensionApiName": "currents-on-demand", + "locations": [ + { + "type": "LatLong", + "value": "33,-97" + } + ], + "language": "en-US", + "units": "e", + "credentials": { + "kind": "ApiKeyAuthCredentials", + "apiKey": { + "keyVaultUri": "https://.vault.azure.net/", + "keyName": "string", + "keyVersion": "string" + } + } + } + }, + "responses": { + "200": { + "body": { + "weatherMetadata": { + "extensionVersion": "1.0", + "weatherDataType": "current", + "extensionId": "IBM.TWC", + "extensionApiName": "currents-on-demand", + "units": "e" + }, + "status": "Succeeded", + "locations": [ + { + "location": { + "type": "LatLong", + "value": "33,-97" + }, + "lastRefreshedDateTime": "2023-02-09T13:02:20Z", + "data": { + "dayOfWeek": [ + "Wednesday" + ], + "dayOrNight": [ + "Night" + ], + "pressureMeanSeaLevel": { + "unit": "inches of mercury", + "value": [ + 1021.1 + ] + }, + "relativeHumidity": { + "unit": "percentage", + "value": [ + 84 + ] + }, + "temperature": { + "unit": "fahrenheit", + "value": [ + 49 + ] + }, + "temperatureDewPoint": { + "unit": "fahrenheit", + "value": [ + 44 + ] + }, + "temperatureFeelsLike": { + "unit": "fahrenheit", + "value": [ + 47 + ] + }, + "temperatureHeatIndex": { + "unit": "fahrenheit", + "value": [ + 49 + ] + }, + "temperatureWindChill": { + "unit": "fahrenheit", + "value": [ + 47 + ] + }, + "uvDescription": [ + "Low" + ], + "uvIndex": [ + 0 + ], + "visibility": { + "unit": "miles", + "value": [ + 10 + ] + }, + "windDirection": { + "unit": "degree", + "value": [ + 150 + ] + }, + "windGust": { + "unit": "miles/hour", + "value": [ + 0 + ] + }, + "windSpeed": { + "unit": "miles/hour", + "value": [ + 4 + ] + }, + "additionalAttributes": { + "cloudCoverPhrase": [ + "Partly Cloudy" + ] + } + } + } + ], + "errors": { + "locations": [] + } + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_CreateCascadeDeleteJob.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_CreateCascadeDeleteJob.json new file mode 100644 index 000000000000..b39eadef507e --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_CreateCascadeDeleteJob.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "partyId": "PARTY123", + "zoneId": "ZONE123", + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "202": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "ZONE123", + "resourceType": "zone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_CreateOrUpdate.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_CreateOrUpdate.json new file mode 100644 index 000000000000..20ec435c98e5 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_CreateOrUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "partyId": "PARTY123", + "zoneId": "Zone123", + "api-version": "2023-11-01-preview", + "zone": { + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + } + } + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + }, + "201": { + "body": { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_Delete.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_Delete.json new file mode 100644 index 000000000000..bfd6bbe5f20b --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "partyId": "PARTY123", + "zoneId": "Zone123", + "api-version": "2023-11-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_Get.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_Get.json new file mode 100644 index 000000000000..bffd8b3c80bc --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "partyId": "PARTY123", + "zoneId": "Zone123" + }, + "responses": { + "200": { + "body": { + "partyId": "PARTY123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "name": "John Smith's Zone", + "description": "Some description", + "source": "source", + "properties": { + "Irrigated": "Yes" + }, + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "createdBy": "00000000-0000-0000-0000-000000000000", + "modifiedBy": "00000000-0000-0000-0000-000000000000", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_GetCascadeDeleteJobDetails.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_GetCascadeDeleteJobDetails.json new file mode 100644 index 000000000000..6c3b9eae63e7 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_GetCascadeDeleteJobDetails.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "jobId": "JOB123" + }, + "responses": { + "200": { + "body": { + "id": "JOB123", + "status": "Succeeded", + "message": "Job completed successfully.", + "durationInSeconds": 14.7977857, + "createdDateTime": "2021-04-19T11:31:20Z", + "lastActionDateTime": "2021-04-19T11:31:34Z", + "startTime": "2021-04-19T11:31:19Z", + "endTime": "2021-04-19T11:31:34Z", + "partyId": "PARTY123", + "resourceId": "ZONE123", + "resourceType": "zone" + } + } + } +} diff --git a/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_Search.json b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_Search.json new file mode 100644 index 000000000000..783a6c8b3133 --- /dev/null +++ b/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2023-11-01-preview/examples/Zones_Search.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "maxPageSize": 50, + "searchZoneQuery": { + "intersectsWithGeometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70457172393799, + 20.545385304358106 + ], + [ + 73.70448589324951, + 20.542411534243367 + ], + [ + 73.70877742767334, + 20.541688176010233 + ], + [ + 73.71023654937744, + 20.545083911372505 + ], + [ + 73.70663166046143, + 20.546992723579137 + ], + [ + 73.70457172393799, + 20.545385304358106 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "partyId": "FARMER123", + "id": "Zone123", + "managementZoneId": "ManagementZone123", + "type": "Nutrient rich", + "status": "Active", + "source": "Agronomist", + "name": "John Smith", + "description": "Some description", + "createdDateTime": "2021-04-21T06:49:30Z", + "modifiedDateTime": "2021-04-21T06:49:30Z", + "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e" + } + ], + "skipToken": "string", + "nextLink": "https://{{resourceName}}.farmbeats.azure.net/zones?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d" + } + } + } +} diff --git a/specification/agrifood/data-plane/readme.java.md b/specification/agrifood/data-plane/readme.java.md index 5e02947e40fb..23666bdc0d2b 100644 --- a/specification/agrifood/data-plane/readme.java.md +++ b/specification/agrifood/data-plane/readme.java.md @@ -1,5 +1,6 @@ ## Generate autorest code -``` yaml + +```yaml java: true output-folder: $(python-sdks-folder)/agrifood/azure-verticals-agrifood-farming namespace: com.azure.verticals.agrifood.farming diff --git a/specification/agrifood/data-plane/readme.md b/specification/agrifood/data-plane/readme.md index a46038857b25..9265fecf6360 100644 --- a/specification/agrifood/data-plane/readme.md +++ b/specification/agrifood/data-plane/readme.md @@ -27,7 +27,7 @@ These are the global settings for the agfood. ```yaml openapi-type: data-plane -tag: package-2023-07-01-preview +tag: package-2023-11-01-preview directive: - suppress: LongRunningResponseStatusCode @@ -88,6 +88,15 @@ input-file: - Microsoft.AgFoodPlatform/preview/2023-07-01-preview/agfood.json ``` +### Tag: package-2023-11-01-preview + +These settings apply only when `--tag=package-2023-11-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-11-01-preview' +input-file: + - Microsoft.AgFoodPlatform/preview/2023-11-01-preview/agfood.json +``` + # Code Generation ## Swagger to SDK @@ -98,4 +107,4 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-java -``` \ No newline at end of file +``` diff --git a/specification/agrifood/resource-manager/readme.java.md b/specification/agrifood/resource-manager/readme.java.md index d1fb784a8e31..291d42f16cea 100644 --- a/specification/agrifood/resource-manager/readme.java.md +++ b/specification/agrifood/resource-manager/readme.java.md @@ -3,7 +3,7 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(java) +```yaml $(java) title: AgriFoodManagementClient service-name: AgriFood ``` diff --git a/specification/agrifood/resource-manager/readme.python.md b/specification/agrifood/resource-manager/readme.python.md index a84e757d6789..2a0e3505e165 100644 --- a/specification/agrifood/resource-manager/readme.python.md +++ b/specification/agrifood/resource-manager/readme.python.md @@ -3,7 +3,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(python) +```yaml $(python) title: AgriFoodMgmtClient azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION @@ -13,7 +13,7 @@ package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) +```yaml $(python) no-namespace-folders: true output-folder: $(python-sdks-folder)/agrifood/azure-mgmt-agrifood/azure/mgmt/agrifood ``` diff --git a/specification/agrifood/resource-manager/readme.typescript.md b/specification/agrifood/resource-manager/readme.typescript.md index 5852cab18e7d..50c798854c1e 100644 --- a/specification/agrifood/resource-manager/readme.typescript.md +++ b/specification/agrifood/resource-manager/readme.typescript.md @@ -3,7 +3,7 @@ These settings apply only when `--typescript` is specified on the command line. Please also specify `--typescript-sdks-folder=`. -``` yaml $(typescript) +```yaml $(typescript) title: AgriFoodMgmtClient typescript: azure-arm: true @@ -11,5 +11,5 @@ typescript: package-name: "@azure/arm-agrifood" output-folder: "$(typescript-sdks-folder)/sdk/agrifood/arm-agrifood" payload-flattening-threshold: 1 - generate-metadata: true + generate-metadata: true ``` diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_CreateOrUpdate.json index a956f82ab4b8..6ca81bceaec6 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "name": "testcontainerApp0", + "name": "testcontainerapp0", "api-version": "2022-01-01-preview", "containerAppEnvelope": { "location": "East US", @@ -34,8 +34,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -78,17 +78,17 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -114,11 +114,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -160,17 +160,17 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto" @@ -184,11 +184,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Delete.json index 420bed6a0dc5..12c52612c674 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "name": "testWorkerApp0", + "name": "testworkerapp0", "api-version": "2022-01-01-preview" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/workerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2021-02-01" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/workerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2021-02-01" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Get.json index 71afe563ddb9..1ffbcec04ecd 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Get.json @@ -2,24 +2,24 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "name": "testcontainerApp0", + "name": "testcontainerapp0", "api-version": "2022-01-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -45,11 +45,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListByResourceGroup.json index 2469e1ed62a7..44397b5ace5a 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListByResourceGroup.json @@ -10,17 +10,17 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -46,11 +46,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListBySubscription.json index 82e0e4447180..f227e9598d4a 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListBySubscription.json @@ -9,17 +9,17 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -45,11 +45,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json index 9b5cafea5e1f..0dbde5ef14ad 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2022-01-01-preview" }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListCustomHostNameAnalysisErrorResponse.json b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListCustomHostNameAnalysisErrorResponse.json index 77180aa3287c..5a977258a8aa 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListCustomHostNameAnalysisErrorResponse.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListCustomHostNameAnalysisErrorResponse.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2022-01-01-preview" }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListSecrets.json index d3f43ccab4a2..f2e56f977abc 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "name": "testcontainerApp0", + "name": "testcontainerapp0", "api-version": "2022-01-01-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Patch.json index 2646a946d4ca..0e7d6a89fbb6 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-01-01-preview/examples/ContainerApps_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "name": "testcontainerApp0", + "name": "testcontainerapp0", "api-version": "2022-01-01-preview", "containerAppEnvelope": { "tags": { @@ -15,8 +15,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "tags": { @@ -26,10 +26,10 @@ "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto" @@ -43,11 +43,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_CreateOrUpdate.json index f60c618e9943..cfa17e04fc7e 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-06-01-preview", "containerAppEnvelope": { "location": "East US", @@ -28,7 +28,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -61,8 +61,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -84,11 +84,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -122,18 +122,18 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileType": "GeneralPurpose", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -152,11 +152,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -185,11 +185,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -212,11 +212,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -249,28 +249,28 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -285,11 +285,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -312,11 +312,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Delete.json index af06b278d424..a2ff98924790 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2022-06-01-preview" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-06-01-preview" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-06-01-preview" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Get.json index 55904dd30014..ee55951efabb 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Get.json @@ -2,25 +2,25 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-06-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileType": "GeneralPurpose", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -39,11 +39,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -76,21 +76,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_GetAuthToken.json index bc78c38ebc5d..d78fe9ca11b5 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_GetAuthToken.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_GetAuthToken.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-06-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps/accesstoken", "location": "East US", "properties": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListByResourceGroup.json index 2601847710ee..4701c201bf0a 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListByResourceGroup.json @@ -10,18 +10,18 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileType": "GeneralPurpose", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -77,21 +77,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListBySubscription.json index d60c3762261f..3888d5d6f240 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListBySubscription.json @@ -9,18 +9,18 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileType": "GeneralPurpose", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -39,11 +39,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -76,21 +76,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json index 4ed7168e0dc1..3ba9dc5ae818 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2022-06-01-preview" }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListSecrets.json index 1d32806d5d95..c37fa6787577 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-06-01-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Patch.json index c755f4be0063..92c1c0643e4c 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-06-01-preview", "containerAppEnvelope": { "location": "East US", @@ -30,7 +30,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -63,8 +63,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -86,11 +86,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -117,18 +117,18 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileType": "GeneralPurpose", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -147,11 +147,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -180,8 +180,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { "cpu": 0.2, "memory": "100Mi" @@ -207,7 +207,7 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { "cpu": 0.2, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json index e7cb34785a35..08bea37ff2e2 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppTcp", + "containerAppName": "testcontainerapptcp", "api-version": "2022-06-01-preview", "containerAppEnvelope": { "location": "East US", @@ -17,7 +17,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" } ] } @@ -25,8 +25,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v1", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v1", + "name": "testcontainerapptcp", "probes": [ { "type": "Liveness", @@ -61,17 +61,17 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -79,11 +79,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -91,11 +91,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -130,17 +130,17 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -148,11 +148,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -160,11 +160,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Replicas_List.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Replicas_List.json index 6ffc39c95e79..af0fc78d50cb 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Replicas_List.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Replicas_List.json @@ -4,7 +4,7 @@ "resourceGroupName": "workerapps-rg-xj", "containerAppName": "myapp", "revisionName": "myapp--0wlqy09", - "api-version": "2021-02-01" + "api-version": "2022-06-01-preview" }, "responses": { "200": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_Get.json index a0bacc0e6974..ffe2d493b808 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_Get.json @@ -4,7 +4,7 @@ "resourceGroupName": "rg", "containerAppName": "testcontainerApp0", "revisionName": "testcontainerApp0-pjxhsye", - "api-version": "2021-02-01" + "api-version": "2022-06-01-preview" }, "responses": { "200": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_List.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_List.json index 3d324514a55e..b6fa18998f14 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_List.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_List.json @@ -3,7 +3,7 @@ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", "containerAppName": "testcontainerApp0", - "api-version": "2021-02-01" + "api-version": "2022-06-01-preview" }, "responses": { "200": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_Restart.json b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_Restart.json index 3336c0109c26..442db81556d5 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_Restart.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/examples/Revisions_Restart.json @@ -4,7 +4,7 @@ "resourceGroupName": "rg", "containerAppName": "testStaticSite0", "revisionName": "testcontainerApp0-pjxhsye", - "api-version": "2021-02-01" + "api-version": "2022-06-01-preview" }, "responses": { "200": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_CreateOrUpdate.json index 1357fcab6302..f1f238ed42e5 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_CreateOrUpdate.json @@ -111,8 +111,8 @@ "image": "repo/testcontainerApp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Delete.json index 0afbe323e9c6..72d1c7d7cebd 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2022-11-01-preview" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01-preview" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01-preview" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Get.json index d7b9beeabc71..b2a1838704c9 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Get.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-11-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -80,21 +80,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_GetAuthToken.json index e391e42d9232..5e5ef13b0d34 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_GetAuthToken.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_GetAuthToken.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-11-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps/accesstoken", "location": "East US", "properties": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListByResourceGroup.json index 0210d0f57f29..dea058a467d5 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListByResourceGroup.json @@ -10,19 +10,19 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -41,11 +41,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -81,8 +81,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { "cpu": 0.2, "memory": "100Mi" @@ -91,11 +91,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListBySubscription.json index 4ce310e94ac9..ab61b016770b 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListBySubscription.json @@ -9,19 +9,19 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -80,21 +80,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json index efb05ee1c7c3..454bb05aa219 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2022-11-01-preview" }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListSecrets.json index 5ee83f926c5d..67f349953396 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-11-01-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json index 7b66525cce28..5ec33a92501b 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppManagedBy", + "containerAppName": "testcontainerappmanagedby", "api-version": "2022-11-01-preview", "containerAppEnvelope": { "location": "East US", @@ -18,7 +18,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" } ] } @@ -26,8 +26,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v1", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v1", + "name": "testcontainerappmanagedby", "probes": [ { "type": "Liveness", @@ -62,19 +62,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", - "name": "testcontainerAppManagedBy", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby", + "name": "testcontainerappmanagedby", "type": "Microsoft.App/containerApps", "location": "East US", "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerAppManagedBy-pjxhsye", + "latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerappmanagedby-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -82,11 +82,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppManagedBy-ab4321" + "revisionName": "testcontainerappmanagedby-ab4321" } ] } @@ -94,8 +94,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v4", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v4", + "name": "testcontainerappmanagedby", "resources": { "cpu": 0.2, "memory": "100Mi" @@ -133,18 +133,18 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", - "name": "testcontainerAppManagedBy", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby", + "name": "testcontainerappmanagedby", "type": "Microsoft.App/containerApps", "location": "East US", "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -152,11 +152,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppManagedBy-ab4321" + "revisionName": "testcontainerappmanagedby-ab4321" } ] } @@ -164,8 +164,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v4", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v4", + "name": "testcontainerappmanagedby", "resources": { "cpu": 0.2, "memory": "100Mi" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Patch.json index 251cf464364c..8fd9d36a2eeb 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-11-01-preview", "containerAppEnvelope": { "location": "East US", @@ -30,7 +30,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -66,8 +66,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -89,7 +89,7 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { "cpu": 0.2, @@ -120,19 +120,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -151,11 +151,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -188,8 +188,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { "cpu": 0.2, "memory": "100Mi" @@ -198,7 +198,7 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { "cpu": 0.2, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json index 7ababadc03df..7dad3811222b 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppTcp", + "containerAppName": "testcontainerapptcp", "api-version": "2022-11-01-preview", "containerAppEnvelope": { "location": "East US", @@ -17,7 +17,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" } ] } @@ -25,8 +25,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v1", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v1", + "name": "testcontainerapptcp", "probes": [ { "type": "Liveness", @@ -61,18 +61,18 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerAppTcp-pjxhsye", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapptcp-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -80,11 +80,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -92,8 +92,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { "cpu": 0.2, "memory": "100Mi" @@ -131,17 +131,17 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -149,11 +149,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -161,8 +161,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { "cpu": 0.2, "memory": "100Mi" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_CreateorUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_CreateorUpdate.json index 459422f7ebcf..a72425a38745 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_CreateorUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_CreateorUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2022-11-01-preview", "JobEnvelope": { "location": "East US", @@ -20,8 +20,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0", "probes": [ { "type": "Liveness", @@ -43,11 +43,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -66,8 +66,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -85,11 +85,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -112,11 +112,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testinitcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -137,8 +137,8 @@ "Location": "location" }, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -156,11 +156,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -184,10 +184,10 @@ "initContainers": [ { "image": "repo/testcontainerAppsJob0:v4", - "name": "testinitcontainerAppsJob0", + "name": "testinitcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Delete.json index d76142bcc5b2..e7444f7e47f0 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testWorkerContainerAppsJob0", + "jobName": "testworkercontainerappsjob0", "api-version": "2022-11-01-preview" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testWorkerContainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01-preview" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testworkercontainerappsjob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01-preview" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Executions_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Executions_Get.json index a905e378446f..f43f25259d3b 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Executions_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Executions_Get.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2022-11-01-preview" }, "responses": { @@ -11,28 +11,28 @@ "body": { "value": [ { - "name": "testcontainerAppJob-27944454", + "name": "testcontainerappjob-27944454", "status": "Running", "startTime": "2023-02-13T20:37:30+00:00", "endTime": "2023-02-13T20:47:30+00:00", "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testinitcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Get.json index cb69b4ddedca..5122aa371a19 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Get.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2022-11-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -28,21 +28,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testinitcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_ListSecrets.json index a438568bb9c6..3d4830a9f995 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2022-11-01-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Patch.json index c27b18092e94..d952b1087d8c 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2022-11-01-preview", "JobEnvelope": { "properties": { @@ -18,8 +18,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0", "probes": [ { "type": "Liveness", @@ -41,7 +41,7 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { "cpu": 0.2, @@ -69,8 +69,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -88,21 +88,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Start.json index acd9742f8347..875cb6a05b0d 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Start.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Start.json @@ -2,25 +2,25 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -38,7 +38,7 @@ "200": { "headers": {}, "body": { - "name": "testcontainerAppsJob0-pjxhsye", + "name": "testcontainerappsjob0-pjxhsye", "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/{containerAppsJobName}/executions/{jobExecutionName}" } }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Stop_Execution.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Stop_Execution.json index 9edacb18de15..aec5713b9fe5 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Stop_Execution.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Stop_Execution.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "jobExecutionName": "jobExecution1", "api-version": "2022-11-01-preview" }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Stop_Multiple.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Stop_Multiple.json index 189abb3a43ca..6ada651c8ead 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Stop_Multiple.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Job_Stop_Multiple.json @@ -2,17 +2,17 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "jobExecutionName": { "value": [ { - "name": "jobExecution-27944453" + "name": "testcontainerappsjob0-27944453" }, { - "name": "jobExecution-27944452" + "name": "testcontainerappsjob0-27944452" }, { - "name": "jobExecution-27944451" + "name": "testcontainerappsjob0-27944451" } ] }, @@ -24,19 +24,19 @@ "body": { "value": [ { - "name": "jobExecution-27944453", + "name": "testcontainerappsjob0-27944453", "status": "Stopped", "startTime": "2023-02-13T20:37:30+00:00", "endTime": "2023-02-13T20:47:30+00:00" }, { - "name": "jobExecution-27944452", + "name": "testcontainerappsjob0-27944452", "status": "Stopped", "startTime": "2023-02-13T20:37:30+00:00", "endTime": "2023-02-13T20:47:30+00:00" }, { - "name": "jobExecution-27944453", + "name": "testcontainerappsjob0-27944453", "status": "Failed", "startTime": "2023-02-13T20:37:30+00:00", "endTime": "2023-02-13T20:47:30+00:00" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Jobs_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Jobs_ListByResourceGroup.json index 73e96466936d..76a62f2d2c41 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Jobs_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Jobs_ListByResourceGroup.json @@ -10,8 +10,8 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -29,21 +29,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] @@ -51,8 +51,8 @@ } }, { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", - "name": "testcontainerAppsJob1", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob1", + "name": "testcontainerappsjob1", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -71,21 +71,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob1:v4", + "image": "repo/testcontainerappsjob1:v4", "name": "testcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testinitcontainerAppsJob1:v4", + "image": "repo/testinitcontainerappsjob1:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Jobs_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Jobs_ListBySubscription.json index f8f58b8e5815..5dc317ab8ae6 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Jobs_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2022-11-01-preview/examples/Jobs_ListBySubscription.json @@ -9,8 +9,8 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -28,21 +28,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testinitcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] @@ -50,8 +50,8 @@ } }, { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", - "name": "testcontainerAppsJob1", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob1", + "name": "testcontainerappsjob1", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -70,21 +70,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob1:v4", - "name": "testcontainerAppsJob1", + "image": "repo/testcontainerappsjob1:v4", + "name": "testcontainerappsjob1", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob1:v4", - "name": "testinitcontainerAppsJob1", + "image": "repo/testcontainerappsjob1:v4", + "name": "testinitcontainerappsjob1", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_CreateOrUpdate.json index 47de8a0d5c16..354e14d475fa 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-04-01-preview", "containerAppEnvelope": { "location": "East US", @@ -28,7 +28,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -88,8 +88,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -111,11 +111,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -155,19 +155,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -186,11 +186,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -222,11 +222,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -249,11 +249,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -286,28 +286,28 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -322,11 +322,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -349,11 +349,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Delete.json index 006901ddad42..010cf118ae2d 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testWorkerapp0", "api-version": "2023-04-01-preview" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-04-01-preview" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-04-01-preview" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Get.json index f425302af374..b6896286febc 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Get.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-04-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -83,21 +83,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_GetAuthToken.json index e5c18f6ae106..7ce5d6795ed1 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_GetAuthToken.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_GetAuthToken.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-04-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps/accesstoken", "location": "East US", "properties": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListByResourceGroup.json index 5f10dec24c86..291168a2516a 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListByResourceGroup.json @@ -10,19 +10,19 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -41,11 +41,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -81,21 +81,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListBySubscription.json index bc20efb9741c..c39bb644cbe7 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListBySubscription.json @@ -9,19 +9,19 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -83,21 +83,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json index 5b83bb9bcf9c..9bce2e68425c 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2023-04-01-preview" }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListSecrets.json index 60ba3aed0f3c..8a9daa14fba1 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-04-01-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json index 6ab2bc97634f..b005c9ef6bc9 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppManagedBy", + "containerAppName": "testcontainerappmanagedby", "api-version": "2023-04-01-preview", "containerAppEnvelope": { "location": "East US", @@ -18,7 +18,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" } ] } @@ -26,8 +26,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v1", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v1", + "name": "testcontainerappmanagedby", "probes": [ { "type": "Liveness", @@ -62,19 +62,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", - "name": "testcontainerAppManagedBy", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby", + "name": "testcontainerappmanagedby", "type": "Microsoft.App/containerApps", "location": "East US", "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerAppManagedBy-pjxhsye", + "latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerappmanagedby-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -82,11 +82,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppManagedBy-ab4321" + "revisionName": "testcontainerappmanagedby-ab4321" } ] } @@ -94,11 +94,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v4", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v4", + "name": "testcontainerappmanagedby", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -133,18 +133,18 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", - "name": "testcontainerAppManagedBy", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby", + "name": "testcontainerappmanagedby", "type": "Microsoft.App/containerApps", "location": "East US", "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -152,11 +152,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppManagedBy-ab4321" + "revisionName": "testcontainerappmanagedby-ab4321" } ] } @@ -164,11 +164,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v4", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v4", + "name": "testcontainerappmanagedby", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Patch.json index 3f33e6a1b3e7..102a726cbe81 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-04-01-preview", "containerAppEnvelope": { "location": "East US", @@ -30,7 +30,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -69,8 +69,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -92,7 +92,7 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { "cpu": 0.2, @@ -129,19 +129,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -160,11 +160,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -197,21 +197,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Start.json index 31a2bf5629c8..e74a43f238e7 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Start.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Start.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2023-04-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -77,21 +77,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -116,7 +116,7 @@ }, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-04-01-preview" + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-04-01-preview" } } } diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Stop.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Stop.json index 31a2bf5629c8..e74a43f238e7 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Stop.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_Stop.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2023-04-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -77,21 +77,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -116,7 +116,7 @@ }, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-04-01-preview" + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-04-01-preview" } } } diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json index ab7834e3fc3b..9ba7d73e5f3b 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppTcp", + "containerAppName": "testcontainerapptcp", "api-version": "2023-04-01-preview", "containerAppEnvelope": { "location": "East US", @@ -17,7 +17,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" } ] } @@ -25,8 +25,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v1", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v1", + "name": "testcontainerapptcp", "probes": [ { "type": "Liveness", @@ -61,18 +61,18 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerAppTcp-pjxhsye", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapptcp-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -80,11 +80,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -92,11 +92,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -131,17 +131,17 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -149,11 +149,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -161,11 +161,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_CreateorUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_CreateorUpdate.json index 4a791ce0cf8e..15999fab0c05 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_CreateorUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_CreateorUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-04-01-preview", "JobEnvelope": { "location": "East US", @@ -20,8 +20,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0", "probes": [ { "type": "Liveness", @@ -43,11 +43,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -66,8 +66,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -85,11 +85,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -112,11 +112,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -137,8 +137,8 @@ "Location": "location" }, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -156,11 +156,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -183,11 +183,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_CreateorUpdate_EventTrigger.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_CreateorUpdate_EventTrigger.json index 46aa4a9a8f82..159257ce516b 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_CreateorUpdate_EventTrigger.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_CreateorUpdate_EventTrigger.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-04-01-preview", "JobEnvelope": { "location": "East US", @@ -34,17 +34,17 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0" + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0" } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -63,8 +63,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -96,8 +96,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { "cpu": 0.2, "memory": "100Mi" @@ -106,11 +106,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -131,8 +131,8 @@ "Location": "location" }, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -165,21 +165,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Delete.json index fb0703520f72..f4221ba73939 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testWorkerContainerAppsJob0", + "jobName": "testworkercontainerappsjob0", "api-version": "2023-04-01-preview" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testWorkerContainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-04-01-preview" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testworkercontainerappsjob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-04-01-preview" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Execution_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Execution_Get.json index 996574bb0da3..b807490d7701 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Execution_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Execution_Get.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "jobExecutionName": "jobExecution1", "api-version": "2023-04-01-preview" }, @@ -17,21 +17,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Executions_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Executions_Get.json index a1d9f125a973..6441f4028fff 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Executions_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Executions_Get.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-04-01-preview" }, "responses": { @@ -18,21 +18,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Get.json index deb3e5258bb0..152fa7020d0e 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Get.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-04-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -28,21 +28,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_ListSecrets.json index f801db1f68e7..34f772659408 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-04-01-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Patch.json index ae8b9d3fed36..572ca68f1f30 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-04-01-preview", "JobEnvelope": { "properties": { @@ -18,8 +18,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0", "probes": [ { "type": "Liveness", @@ -41,11 +41,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -69,8 +69,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -88,21 +88,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Start.json index 9b733831a8e0..ab01d7286152 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Start.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Start.json @@ -2,25 +2,25 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -38,7 +38,7 @@ "200": { "headers": {}, "body": { - "name": "testcontainerAppsJob0-pjxhsye", + "name": "testcontainerappsjob0-pjxhsye", "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/{containerAppsJobName}/executions/{jobExecutionName}" } }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Stop_Execution.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Stop_Execution.json index 1c5d6d96f5ab..5e470e5bb24f 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Stop_Execution.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Stop_Execution.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "jobExecutionName": "jobExecution1", "api-version": "2023-04-01-preview" }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Stop_Multiple.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Stop_Multiple.json index 0762042597b2..7b2712075997 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Stop_Multiple.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Stop_Multiple.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "jobExecutionName": { "value": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Jobs_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Jobs_ListByResourceGroup.json index ae6a5a6dccb8..f268542c2fbd 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Jobs_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Jobs_ListByResourceGroup.json @@ -10,8 +10,8 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -29,21 +29,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] @@ -51,8 +51,8 @@ } }, { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", - "name": "testcontainerAppsJob1", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob1", + "name": "testcontainerappsjob1", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -71,11 +71,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob1:v4", + "image": "repo/testcontainerappsjob1:v4", "name": "testcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -84,8 +84,8 @@ "image": "repo/testinitcontainerAppsJob1:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Jobs_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Jobs_ListBySubscription.json index bc9eebd85b25..913e39619c92 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Jobs_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Jobs_ListBySubscription.json @@ -9,8 +9,8 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -28,21 +28,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] @@ -50,8 +50,8 @@ } }, { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", - "name": "testcontainerAppsJob1", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob1", + "name": "testcontainerappsjob1", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -70,21 +70,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob1:v4", - "name": "testcontainerAppsJob1", + "image": "repo/testcontainerappsjob1:v4", + "name": "testcontainerappsjob1", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob1:v4", + "image": "repo/testcontainerappsjob1:v4", "name": "testinitcontainerAppsJob1", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_CreateOrUpdate.json index a90356136e44..e7e85336d0cb 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-05-02-preview", "containerAppEnvelope": { "location": "East US", @@ -28,7 +28,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -99,8 +99,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -122,11 +122,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -166,19 +166,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -197,11 +197,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -233,11 +233,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -260,11 +260,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -297,28 +297,28 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -333,11 +333,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -360,11 +360,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Delete.json index 7edde7029cbd..f316d39d9b26 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2023-05-02-preview" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-02-preview" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-02-preview" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Get.json index f4965945712b..e18439e961ee 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Get.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-05-02-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -83,21 +83,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_GetAuthToken.json index 80fa796895c3..0434fea24a52 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_GetAuthToken.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_GetAuthToken.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-05-02-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps/accesstoken", "location": "East US", "properties": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListByResourceGroup.json index c5f3a31e974d..c8ae8a7c2750 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListByResourceGroup.json @@ -10,19 +10,19 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -41,11 +41,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -81,21 +81,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListBySubscription.json index d10d3280d812..8f71306d3abc 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListBySubscription.json @@ -9,19 +9,19 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -83,21 +83,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json index 60e0f48bc7c6..40e6cebf794c 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2023-05-02-preview" }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListSecrets.json index 29f19073e8f2..7b08826532c3 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-05-02-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json index cd2c1719b273..6864638b6174 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppManagedBy", + "containerAppName": "testcontainerappmanagedby", "api-version": "2023-05-02-preview", "containerAppEnvelope": { "location": "East US", @@ -18,7 +18,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" } ] } @@ -26,8 +26,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v1", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v1", + "name": "testcontainerappmanagedby", "probes": [ { "type": "Liveness", @@ -62,19 +62,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", - "name": "testcontainerAppManagedBy", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby", + "name": "testcontainerappmanagedby", "type": "Microsoft.App/containerApps", "location": "East US", "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerAppManagedBy-pjxhsye", + "latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerappmanagedby-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -82,11 +82,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppManagedBy-ab4321" + "revisionName": "testcontainerappmanagedby-ab4321" } ] } @@ -94,11 +94,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v4", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v4", + "name": "testcontainerappmanagedby", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -133,18 +133,18 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", - "name": "testcontainerAppManagedBy", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby", + "name": "testcontainerappmanagedby", "type": "Microsoft.App/containerApps", "location": "East US", "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -152,11 +152,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppManagedBy-ab4321" + "revisionName": "testcontainerappmanagedby-ab4321" } ] } @@ -164,11 +164,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v4", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v4", + "name": "testcontainerappmanagedby", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Patch.json index 30d66fa07bb8..8584497c022f 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-05-02-preview", "containerAppEnvelope": { "location": "East US", @@ -30,7 +30,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -69,8 +69,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -92,11 +92,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -129,19 +129,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -160,11 +160,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -197,21 +197,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Start.json index 31cd37818252..d3c95f424cf2 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Start.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Start.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2023-05-02-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -77,21 +77,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -116,7 +116,7 @@ }, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-02-preview" + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-02-preview" } } } diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Stop.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Stop.json index 31cd37818252..b94226bc6ae6 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Stop.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_Stop.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerApp0", "api-version": "2023-05-02-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -77,8 +77,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { "cpu": 0.2, "memory": "100Mi" @@ -87,11 +87,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -116,7 +116,7 @@ }, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-02-preview" + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-02-preview" } } } diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json index 8b6761f89a5c..5284ae655a95 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppTcp", + "containerAppName": "testcontainerapptcp", "api-version": "2023-05-02-preview", "containerAppEnvelope": { "location": "East US", @@ -17,7 +17,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" } ] } @@ -25,8 +25,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v1", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v1", + "name": "testcontainerapptcp", "probes": [ { "type": "Liveness", @@ -61,18 +61,18 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerAppTcp-pjxhsye", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapptcp-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -80,11 +80,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -92,11 +92,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -131,17 +131,17 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -149,11 +149,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -161,11 +161,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_CreateorUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_CreateorUpdate.json index 10ecb7823680..6a9c09de4dcb 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_CreateorUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_CreateorUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsob0", "api-version": "2023-05-02-preview", "JobEnvelope": { "location": "East US", @@ -20,8 +20,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v1", + "name": "testcontainerappsob0", "probes": [ { "type": "Liveness", @@ -43,11 +43,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -66,8 +66,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsob0", + "name": "testcontainerappsob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -85,11 +85,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -112,11 +112,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -137,8 +137,8 @@ "Location": "location" }, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsob0", + "name": "testcontainerappsob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -156,11 +156,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -183,11 +183,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_CreateorUpdate_EventTrigger.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_CreateorUpdate_EventTrigger.json index ccbdbb3e48aa..2742923be7b2 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_CreateorUpdate_EventTrigger.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_CreateorUpdate_EventTrigger.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsob0", "api-version": "2023-05-02-preview", "JobEnvelope": { "location": "East US", @@ -34,17 +34,17 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0" + "image": "repo/testcontainerappsob0:v1", + "name": "testcontainerappsob0" } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -63,8 +63,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsob0", + "name": "testcontainerappsob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -96,21 +96,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -131,8 +131,8 @@ "Location": "location" }, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsob0", + "name": "testcontainerappsob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -165,21 +165,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Delete.json index ce43ec61ba5d..1b3f3e081b03 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testWorkerContainerAppsJob0", + "jobName": "testworkercontainerappsjob0", "api-version": "2023-05-02-preview" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testWorkerContainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-02-preview" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testworkercontainerappsjob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-02-preview" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Execution_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Execution_Get.json index 0e5215002832..9d10bf5c10c9 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Execution_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Execution_Get.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsob0", "jobExecutionName": "jobExecution1", "api-version": "2023-05-02-preview" }, @@ -17,21 +17,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Executions_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Executions_Get.json index c6b437ff8d1b..1aaa501ca5a7 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Executions_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Executions_Get.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsob0", "api-version": "2023-05-02-preview" }, "responses": { @@ -18,21 +18,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Get.json index 67eaa1f70154..d9eabe083de1 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Get.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsob0", "api-version": "2023-05-02-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsob0", + "name": "testcontainerappsob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -28,21 +28,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_ListSecrets.json index b1751c67ee82..24b5e7d2f81f 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsob0", "api-version": "2023-05-02-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Patch.json index 44fd13141889..7afc279f7cc2 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsob0", "api-version": "2023-05-02-preview", "JobEnvelope": { "properties": { @@ -18,8 +18,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v1", + "name": "testcontainerappsob0", "probes": [ { "type": "Liveness", @@ -41,11 +41,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -69,8 +69,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsob0", + "name": "testcontainerappsob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -88,21 +88,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Start.json index 196a992b6833..d0880970bb5a 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Start.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Start.json @@ -2,25 +2,25 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsob0", "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -38,7 +38,7 @@ "200": { "headers": {}, "body": { - "name": "testcontainerAppsJob0-pjxhsye", + "name": "testcontainerappsob0-pjxhsye", "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/{containerAppsJobName}/executions/{jobExecutionName}" } }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Stop_Execution.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Stop_Execution.json index 6189330aafec..218739a2a899 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Stop_Execution.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Stop_Execution.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsob0", "jobExecutionName": "jobExecution1", "api-version": "2023-05-02-preview" }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Stop_Multiple.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Stop_Multiple.json index 8ee01754a161..6ffd51c2d21e 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Stop_Multiple.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Job_Stop_Multiple.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsob0", "jobExecutionName": { "value": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Jobs_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Jobs_ListByResourceGroup.json index a6b3cdc8be20..bab95a29433f 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Jobs_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Jobs_ListByResourceGroup.json @@ -10,8 +10,8 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsob0", + "name": "testcontainerappsob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -29,21 +29,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] @@ -51,8 +51,8 @@ } }, { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", - "name": "testcontainerAppsJob1", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsob1", + "name": "testcontainerappsob1", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -71,11 +71,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob1:v4", + "image": "repo/testcontainerappsob1:v4", "name": "testcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -84,8 +84,8 @@ "image": "repo/testinitcontainerAppsJob1:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Jobs_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Jobs_ListBySubscription.json index 83a7fcf7939e..1f08e5289067 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Jobs_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-05-02-preview/examples/Jobs_ListBySubscription.json @@ -9,8 +9,8 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsob0", + "name": "testcontainerappsob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -28,21 +28,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsob0:v4", + "name": "testcontainerappsob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] @@ -50,8 +50,8 @@ } }, { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", - "name": "testcontainerAppsJob1", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsob1", + "name": "testcontainerappsob1", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -70,21 +70,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob1:v4", - "name": "testcontainerAppsJob1", + "image": "repo/testcontainerappsob1:v4", + "name": "testcontainerappsob1", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob1:v4", + "image": "repo/testcontainerappsob1:v4", "name": "testinitcontainerAppsJob1", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_CreateOrUpdate.json index 968532b8c538..77cd2be71748 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-08-01-preview", "containerAppEnvelope": { "location": "East US", @@ -28,7 +28,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -99,8 +99,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -122,11 +122,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -170,19 +170,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -201,11 +201,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -237,11 +237,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -264,11 +264,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -301,28 +301,28 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -337,11 +337,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -364,11 +364,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json index fab93cc06989..9404c9603492 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-08-01-preview", "containerAppEnvelope": { "location": "East US", @@ -31,7 +31,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -99,8 +99,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -122,11 +122,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -160,8 +160,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "extendedLocation": { @@ -171,11 +171,11 @@ "properties": { "provisioningState": "Succeeded", "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -194,11 +194,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -230,11 +230,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -257,11 +257,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -294,8 +294,8 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "extendedLocation": { @@ -305,21 +305,21 @@ "properties": { "provisioningState": "InProgress", "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -334,11 +334,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -361,11 +361,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Delete.json index e8feab8aab78..d13d28daceeb 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2023-08-01-preview" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-08-01-preview" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-08-01-preview" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Get.json index 34fb614112f5..df7c4b9442b8 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Get.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-08-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -83,21 +83,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_GetAuthToken.json index 54796f6f11b9..b73226f3e0d5 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_GetAuthToken.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_GetAuthToken.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-08-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps/accesstoken", "location": "East US", "properties": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListByResourceGroup.json index 3817a8abb23d..3cab583b7780 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListByResourceGroup.json @@ -10,19 +10,19 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -41,11 +41,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -81,21 +81,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListBySubscription.json index 567cfb6cbb43..5a55749365fb 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListBySubscription.json @@ -9,19 +9,19 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -83,21 +83,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json index 20a28a77a8b0..3dffd7ee3531 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2023-08-01-preview" }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListSecrets.json index 4b309ac9902e..fdb7da42a711 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-08-01-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json index b93aea9f5ba6..fa61deee5011 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppManagedBy", + "containerAppName": "testcontainerappmanagedby", "api-version": "2023-08-01-preview", "containerAppEnvelope": { "location": "East US", @@ -18,7 +18,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" } ] } @@ -26,8 +26,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v1", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v1", + "name": "testcontainerappmanagedby", "probes": [ { "type": "Liveness", @@ -62,19 +62,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", - "name": "testcontainerAppManagedBy", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby", + "name": "testcontainerappmanagedby", "type": "Microsoft.App/containerApps", "location": "East US", "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerAppManagedBy-pjxhsye", + "latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerappmanagedby-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -82,11 +82,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppManagedBy-ab4321" + "revisionName": "testcontainerappmanagedby-ab4321" } ] } @@ -94,11 +94,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v4", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v4", + "name": "testcontainerappmanagedby", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -133,18 +133,18 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", - "name": "testcontainerAppManagedBy", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby", + "name": "testcontainerappmanagedby", "type": "Microsoft.App/containerApps", "location": "East US", "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -152,11 +152,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppManagedBy-ab4321" + "revisionName": "testcontainerappmanagedby-ab4321" } ] } @@ -164,11 +164,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v4", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v4", + "name": "testcontainerappmanagedby", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Patch.json index 49559100a717..06317ce33834 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-08-01-preview", "containerAppEnvelope": { "location": "East US", @@ -30,7 +30,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -69,8 +69,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -92,11 +92,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -133,19 +133,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -164,11 +164,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -201,17 +201,17 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { "cpu": 0.2, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Start.json index af8df4ed7566..cf976058a6cd 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Start.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Start.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2023-08-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -77,21 +77,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -116,7 +116,7 @@ }, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-08-01-preview" + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-08-01-preview" } } } diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Stop.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Stop.json index af8df4ed7566..cf976058a6cd 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Stop.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_Stop.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2023-08-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -77,21 +77,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -116,7 +116,7 @@ }, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-08-01-preview" + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-08-01-preview" } } } diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json index 89b8aea117bb..90e616c68bae 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppTcp", + "containerAppName": "testcontainerapptcp", "api-version": "2023-08-01-preview", "containerAppEnvelope": { "location": "East US", @@ -17,7 +17,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" } ] } @@ -25,8 +25,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v1", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v1", + "name": "testcontainerapptcp", "probes": [ { "type": "Liveness", @@ -61,18 +61,18 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerAppTcp-pjxhsye", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapptcp-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -80,11 +80,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -92,11 +92,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -131,17 +131,17 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -149,11 +149,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -161,11 +161,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate.json index e77ed058ecad..9397268f6c05 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-08-01-preview", "JobEnvelope": { "location": "East US", @@ -20,8 +20,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0", "probes": [ { "type": "Liveness", @@ -43,11 +43,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -66,8 +66,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -85,11 +85,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -112,11 +112,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -137,8 +137,8 @@ "Location": "location" }, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -156,11 +156,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -183,11 +183,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json index 62179dbdbf9a..aefc10c32185 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-08-01-preview", "JobEnvelope": { "location": "East US", @@ -24,8 +24,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0", "probes": [ { "type": "Liveness", @@ -47,11 +47,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -70,8 +70,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "extendedLocation": { @@ -93,11 +93,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -120,11 +120,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -145,8 +145,8 @@ "Location": "location" }, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "extendedLocation": { @@ -168,11 +168,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -195,11 +195,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate_EventTrigger.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate_EventTrigger.json index 418540a0cec4..d10d03dd0304 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate_EventTrigger.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_CreateorUpdate_EventTrigger.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-08-01-preview", "JobEnvelope": { "location": "East US", @@ -34,17 +34,17 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0" + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0" } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -63,8 +63,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -96,21 +96,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -131,8 +131,8 @@ "Location": "location" }, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -165,17 +165,17 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { "cpu": 0.2, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Delete.json index 1822598c1cce..b666e5d2be13 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testWorkerContainerAppsJob0", + "jobName": "testworkercontainerappsjob0", "api-version": "2023-08-01-preview" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testWorkerContainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-08-01-preview" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testworkercontainerappsjob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-08-01-preview" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Execution_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Execution_Get.json index 201dbb87fa56..79e0eebca70c 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Execution_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Execution_Get.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "jobExecutionName": "jobExecution1", "api-version": "2023-08-01-preview" }, @@ -17,21 +17,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Executions_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Executions_Get.json index d7b1f0bba873..627ee0b8965a 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Executions_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Executions_Get.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-08-01-preview" }, "responses": { @@ -18,21 +18,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Get.json index 65d39d92fffe..71673e847324 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Get.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Get.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-08-01-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -28,21 +28,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_ListSecrets.json index 4d602302fce2..c5e8fefbd498 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-08-01-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Patch.json index d2215ca0f257..265f5789cc84 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-08-01-preview", "JobEnvelope": { "properties": { @@ -18,8 +18,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0", "probes": [ { "type": "Liveness", @@ -41,11 +41,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -69,8 +69,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -88,21 +88,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_ProxyGet.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_ProxyGet.json index 8f1800436018..f9c5b50c911c 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_ProxyGet.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_ProxyGet.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "apiName": "rootApi", "api-version": "2023-08-01-preview" }, @@ -10,8 +10,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0/detectorproperties/rootApi", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0/detectorproperties/rootApi", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -29,21 +29,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Start.json index 041a5964047e..c7d14dc7e7c4 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Start.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Start.json @@ -2,25 +2,25 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -38,7 +38,7 @@ "200": { "headers": {}, "body": { - "name": "testcontainerAppsJob0-pjxhsye", + "name": "testcontainerappsjob0-pjxhsye", "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/{containerAppsJobName}/executions/{jobExecutionName}" } }, diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Stop_Execution.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Stop_Execution.json index 835247cf7019..c381a346784e 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Stop_Execution.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Stop_Execution.json @@ -2,8 +2,8 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", - "jobExecutionName": "jobExecution1", + "jobName": "testcontainerappsjob0", + "jobExecutionName": "jobexecution1", "api-version": "2023-08-01-preview" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Stop_Multiple.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Stop_Multiple.json index 40fc541673dc..80a4abc00c48 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Stop_Multiple.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Job_Stop_Multiple.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "jobExecutionName": { "value": [ { diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Jobs_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Jobs_ListByResourceGroup.json index 2352b1501169..35987ae1bc9b 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Jobs_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Jobs_ListByResourceGroup.json @@ -10,8 +10,8 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -29,17 +29,17 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { "cpu": 0.2, @@ -51,8 +51,8 @@ } }, { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", - "name": "testcontainerAppsJob1", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob1", + "name": "testcontainerappsjob1", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -71,11 +71,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob1:v4", + "image": "repo/testcontainerappsjob1:v4", "name": "testcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -84,8 +84,8 @@ "image": "repo/testinitcontainerAppsJob1:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Jobs_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Jobs_ListBySubscription.json index 85de258d4be5..7f1e2bddd917 100644 --- a/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Jobs_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Jobs_ListBySubscription.json @@ -9,8 +9,8 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -28,21 +28,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] @@ -50,8 +50,8 @@ } }, { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", - "name": "testcontainerAppsJob1", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob1", + "name": "testcontainerappsjob1", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -70,21 +70,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob1:v4", - "name": "testcontainerAppsJob1", + "image": "repo/testcontainerappsjob1:v4", + "name": "testcontainerappsjob1", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob1:v4", + "image": "repo/testcontainerappsjob1:v4", "name": "testinitcontainerAppsJob1", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_CreateOrUpdate.json index bbaee0fdb8bb..61576bd4d9c0 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-03-01", "containerAppEnvelope": { "location": "East US", @@ -27,7 +27,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ] @@ -41,8 +41,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -85,17 +85,17 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -114,11 +114,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -132,11 +132,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -178,28 +178,28 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -213,11 +213,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Delete.json index a53fe7450123..1c9e9d60f66d 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2022-03-01" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-03-01" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-03-01" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Get.json index 8ad2263501c7..029f060ab796 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Get.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Get.json @@ -2,24 +2,24 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-03-01" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -38,11 +38,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -56,11 +56,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListByResourceGroup.json index cde745ea2628..1076b4f63cf7 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListByResourceGroup.json @@ -10,17 +10,17 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -39,11 +39,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -57,11 +57,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListBySubscription.json index e91c1ab46fe8..8d9b053b0d20 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListBySubscription.json @@ -9,17 +9,17 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -38,11 +38,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -56,11 +56,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListCustomHostNameAnalysis.json index 7a31ac351009..ab9422728807 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListCustomHostNameAnalysis.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2022-03-01" }, diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListCustomHostNameAnalysisErrorResponse.json b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListCustomHostNameAnalysisErrorResponse.json index 21dfa5acbb21..164c168c96d1 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListCustomHostNameAnalysisErrorResponse.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListCustomHostNameAnalysisErrorResponse.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2022-03-01" }, diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListSecrets.json index 3ce88feb36d5..cf628e31322f 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-03-01" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Patch.json index c5e8965a1fa1..2cb1c0be98e5 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/examples/ContainerApps_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-03-01", "containerAppEnvelope": { "location": "East US", @@ -30,7 +30,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ] @@ -44,8 +44,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -93,17 +93,17 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -122,11 +122,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -140,11 +140,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_CreateOrUpdate.json index ee01cd2b8091..9e9440cf108b 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-10-01", "containerAppEnvelope": { "location": "East US", @@ -28,7 +28,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -82,8 +82,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -105,11 +105,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -143,20 +143,20 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileType": "GeneralPurpose", - "latestRevisionName": "testcontainerApp0-pjxhsye", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionName": "testcontainerapp0-pjxhsye", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -175,11 +175,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -208,11 +208,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -235,11 +235,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -272,30 +272,30 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionName": "testcontainerApp0-pjxhsye", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionName": "testcontainerapp0-pjxhsye", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -310,11 +310,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -337,11 +337,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Delete.json index e3a7657a6a13..929bb9e78167 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2022-10-01" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-10-01" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-10-01" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Get.json index 70861d3dc287..2b1db5d08d33 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Get.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Get.json @@ -2,27 +2,27 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-10-01" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileType": "GeneralPurpose", - "latestRevisionName": "testcontainerApp0-pjxhsye", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionName": "testcontainerapp0-pjxhsye", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -41,11 +41,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -78,21 +78,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_GetAuthToken.json index d48ff3122df0..856146f83331 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_GetAuthToken.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_GetAuthToken.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-10-01" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps/accesstoken", "location": "East US", "properties": { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListByResourceGroup.json index 640b3d5750fd..4825505b6cb4 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListByResourceGroup.json @@ -10,20 +10,20 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileType": "GeneralPurpose", - "latestRevisionName": "testcontainerApp0-pjxhsye", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionName": "testcontainerapp0-pjxhsye", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -42,11 +42,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -79,8 +79,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { "cpu": 0.2, "memory": "100Mi" @@ -89,11 +89,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListBySubscription.json index 2b49b3a392a9..881d2284e3b2 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListBySubscription.json @@ -9,20 +9,20 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileType": "GeneralPurpose", - "latestRevisionName": "testcontainerApp0-pjxhsye", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionName": "testcontainerapp0-pjxhsye", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -41,11 +41,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -78,21 +78,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListCustomHostNameAnalysis.json index 04fe2215eedc..f71f97c96fb3 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListCustomHostNameAnalysis.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2022-10-01" }, diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListSecrets.json index 6f723804301f..c4f42e478391 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-10-01" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Patch.json index 02f5384577e9..1321959a4f7a 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2022-10-01", "containerAppEnvelope": { "location": "East US", @@ -30,7 +30,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -63,8 +63,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -86,11 +86,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -117,20 +117,20 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileType": "GeneralPurpose", - "latestRevisionName": "testcontainerApp0-pjxhsye", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionName": "testcontainerapp0-pjxhsye", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -149,11 +149,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -182,11 +182,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -209,11 +209,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_TcpApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_TcpApp_CreateOrUpdate.json index 4651848141ae..880689ee4ef3 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_TcpApp_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2022-10-01/examples/ContainerApps_TcpApp_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppTcp", + "containerAppName": "testcontainerapptcp", "api-version": "2022-10-01", "containerAppEnvelope": { "location": "East US", @@ -17,7 +17,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" } ] } @@ -25,8 +25,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v1", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v1", + "name": "testcontainerapptcp", "probes": [ { "type": "Liveness", @@ -61,19 +61,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionName": "testcontainerAppTcp-pjxhsye", - "latestReadyRevisionName": "testcontainerAppTcp-pjxhsye", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionName": "testcontainerapptcp-pjxhsye", + "latestReadyRevisionName": "testcontainerapptcp-pjxhsye", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -81,11 +81,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -93,11 +93,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -132,19 +132,19 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionName": "testcontainerAppTcp-pjxhsye", - "latestReadyRevisionName": "testcontainerAppTcp-pjxhsye", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionName": "testcontainerapptcp-pjxhsye", + "latestReadyRevisionName": "testcontainerapptcp-pjxhsye", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -152,11 +152,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -164,11 +164,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_CreateOrUpdate.json index 92e74a04234f..8872308a76da 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-05-01", "containerAppEnvelope": { "location": "East US", @@ -28,7 +28,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -88,8 +88,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -111,11 +111,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -155,19 +155,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -186,11 +186,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -222,11 +222,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -249,11 +249,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -286,28 +286,28 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ] @@ -322,11 +322,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -349,11 +349,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Delete.json index b50692d1b5f7..507691c2d0d6 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2023-05-01" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-01" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-01" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Get.json index a31d926bf214..5a4270084f45 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Get.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Get.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-05-01" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -83,21 +83,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_GetAuthToken.json index 0db007427f53..cde47e085423 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_GetAuthToken.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_GetAuthToken.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-05-01" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps/accesstoken", "location": "East US", "properties": { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListByResourceGroup.json index f08db7684e34..88cabd25bbc6 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListByResourceGroup.json @@ -10,19 +10,19 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -41,11 +41,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -81,21 +81,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListBySubscription.json index 6266f1dad74c..1dce99b22475 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListBySubscription.json @@ -9,19 +9,19 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -83,21 +83,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListCustomHostNameAnalysis.json index 8174af49e7c4..f0e4c02fdd86 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListCustomHostNameAnalysis.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "customHostname": "my.name.corp", "api-version": "2023-05-01" }, diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListSecrets.json index 5d3f1ad8880a..606b88d96852 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-05-01" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ManagedBy_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ManagedBy_CreateOrUpdate.json index ed5d9bd5645e..48ad62d12bcf 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ManagedBy_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_ManagedBy_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppManagedBy", + "containerAppName": "testcontainerappmanagedby", "api-version": "2023-05-01", "containerAppEnvelope": { "location": "East US", @@ -18,7 +18,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" } ] } @@ -26,8 +26,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v1", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v1", + "name": "testcontainerappmanagedby", "probes": [ { "type": "Liveness", @@ -62,19 +62,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", - "name": "testcontainerAppManagedBy", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby", + "name": "testcontainerappmanagedby", "type": "Microsoft.App/containerApps", "location": "East US", "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerAppManagedBy-pjxhsye", + "latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerappmanagedby-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -82,11 +82,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppManagedBy-ab4321" + "revisionName": "testcontainerappmanagedby-ab4321" } ] } @@ -94,11 +94,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v4", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v4", + "name": "testcontainerappmanagedby", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -133,18 +133,18 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", - "name": "testcontainerAppManagedBy", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerappmanagedby", + "name": "testcontainerappmanagedby", "type": "Microsoft.App/containerApps", "location": "East US", "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerappmanagedby-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerappmanagedby.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -152,11 +152,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppManagedBy-ab1234" + "revisionName": "testcontainerappmanagedby-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppManagedBy-ab4321" + "revisionName": "testcontainerappmanagedby-ab4321" } ] } @@ -164,11 +164,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppManagedBy:v4", - "name": "testcontainerAppManagedBy", + "image": "repo/testcontainerappmanagedby:v4", + "name": "testcontainerappmanagedby", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Patch.json index db4665e2815e..76264e610049 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerApp0", + "containerAppName": "testcontainerapp0", "api-version": "2023-05-01", "containerAppEnvelope": { "location": "East US", @@ -30,7 +30,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerApp0-ab1234", + "revisionName": "testcontainerapp0-ab1234", "label": "production" } ], @@ -69,8 +69,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v1", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v1", + "name": "testcontainerapp0", "probes": [ { "type": "Liveness", @@ -92,11 +92,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -129,19 +129,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -160,11 +160,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -197,21 +197,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Start.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Start.json index 81390010e202..204ebf1c7eeb 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Start.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Start.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2023-05-01" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -77,21 +77,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -116,7 +116,7 @@ }, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-01" + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-01" } } } diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Stop.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Stop.json index 81390010e202..204ebf1c7eeb 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Stop.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_Stop.json @@ -2,26 +2,26 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testWorkerApp0", + "containerAppName": "testworkerapp0", "api-version": "2023-05-01" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", - "name": "testcontainerApp0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapp0", + "name": "testcontainerapp0", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", "workloadProfileName": "My-GP-01", - "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "latestRevisionFqdn": "testcontainerapp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapp0-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "transport": "auto", @@ -40,11 +40,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerApp0-ab1234" + "revisionName": "testcontainerapp0-ab1234" }, { "weight": 20, - "revisionName": "testcontainerApp0-ab4321", + "revisionName": "testcontainerapp0-ab4321", "label": "staging" } ], @@ -77,21 +77,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerApp0:v4", - "name": "testcontainerApp0", + "image": "repo/testcontainerapp0:v4", + "name": "testcontainerapp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerApp0:v4", + "image": "repo/testcontainerapp0:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -116,7 +116,7 @@ }, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-01" + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testworkerapp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-01" } } } diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_TcpApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_TcpApp_CreateOrUpdate.json index 905b6fe89d07..8428af49386c 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_TcpApp_CreateOrUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/ContainerApps_TcpApp_CreateOrUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "containerAppName": "testcontainerAppTcp", + "containerAppName": "testcontainerapptcp", "api-version": "2023-05-01", "containerAppEnvelope": { "location": "East US", @@ -17,7 +17,7 @@ "traffic": [ { "weight": 100, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" } ] } @@ -25,8 +25,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v1", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v1", + "name": "testcontainerapptcp", "probes": [ { "type": "Liveness", @@ -61,18 +61,18 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "Succeeded", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", - "latestReadyRevisionName": "testcontainerAppTcp-pjxhsye", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerapptcp-pjxhsye", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -80,11 +80,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -92,11 +92,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -131,17 +131,17 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", - "name": "testcontainerAppTcp", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerapptcp", + "name": "testcontainerapptcp", "type": "Microsoft.App/containerApps", "location": "East US", "properties": { "provisioningState": "InProgress", "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", - "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestRevisionFqdn": "testcontainerapptcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", "configuration": { "ingress": { - "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "fqdn": "testcontainerapptcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", "external": true, "targetPort": 3000, "exposedPort": 4000, @@ -149,11 +149,11 @@ "traffic": [ { "weight": 80, - "revisionName": "testcontainerAppTcp-ab1234" + "revisionName": "testcontainerapptcp-ab1234" }, { "weight": 20, - "revisionName": "testcontainerAppTcp-ab4321" + "revisionName": "testcontainerapptcp-ab4321" } ] } @@ -161,11 +161,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppTcp:v4", - "name": "testcontainerAppTcp", + "image": "repo/testcontainerapptcp:v4", + "name": "testcontainerapptcp", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_CreateorUpdate.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_CreateorUpdate.json index 8c8e105e1a47..52dfa54b955b 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_CreateorUpdate.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_CreateorUpdate.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-05-01", "JobEnvelope": { "location": "East US", @@ -20,8 +20,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0", "probes": [ { "type": "Liveness", @@ -43,11 +43,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -66,8 +66,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -85,11 +85,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -112,11 +112,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -137,8 +137,8 @@ "Location": "location" }, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -156,11 +156,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "probes": [ { @@ -183,11 +183,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_CreateorUpdate_EventTrigger.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_CreateorUpdate_EventTrigger.json index b131b7520f40..ffc99e0d835e 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_CreateorUpdate_EventTrigger.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_CreateorUpdate_EventTrigger.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-05-01", "JobEnvelope": { "location": "East US", @@ -34,17 +34,17 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0" + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0" } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -63,8 +63,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -96,21 +96,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -131,8 +131,8 @@ "Location": "location" }, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -165,21 +165,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Delete.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Delete.json index 4dd3b30c50da..58fe22e99787 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Delete.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Delete.json @@ -2,14 +2,14 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testWorkerContainerAppsJob0", + "jobName": "testworkercontainerappsjob0", "api-version": "2023-05-01" }, "responses": { "200": {}, "202": { "headers": { - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testWorkerContainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-01" + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testworkercontainerappsjob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-05-01" } }, "204": {} diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Execution_Get.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Execution_Get.json index 5a96d6477d85..8065d25b39a2 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Execution_Get.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Execution_Get.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "jobExecutionName": "jobExecution1", "api-version": "2023-05-01" }, @@ -17,21 +17,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Executions_Get.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Executions_Get.json index bd48031206da..8b4c66ca3a0f 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Executions_Get.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Executions_Get.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-05-01" }, "responses": { @@ -18,21 +18,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Get.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Get.json index 392fd5d05d73..d578327fa379 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Get.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Get.json @@ -2,15 +2,15 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-05-01" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -28,21 +28,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_ListSecrets.json index 1d9a3c7d5229..6f9b36c0000a 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_ListSecrets.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_ListSecrets.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-05-01" }, "responses": { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Patch.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Patch.json index af668c00e855..6f1db8d9a086 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Patch.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Patch.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "api-version": "2023-05-01", "JobEnvelope": { "properties": { @@ -18,8 +18,8 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v1", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v1", + "name": "testcontainerappsjob0", "probes": [ { "type": "Liveness", @@ -41,11 +41,11 @@ ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -69,8 +69,8 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -88,21 +88,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Start.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Start.json index a2847a73829b..d0ddb98e5fad 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Start.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Start.json @@ -2,25 +2,25 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" }, "command": [ "/bin/sh" @@ -38,7 +38,7 @@ "200": { "headers": {}, "body": { - "name": "testcontainerAppsJob0-pjxhsye", + "name": "testcontainerappsjob0-pjxhsye", "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/{containerAppsJobName}/executions/{jobExecutionName}" } }, diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Stop_Execution.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Stop_Execution.json index 7823a5a6980b..55570862d6ac 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Stop_Execution.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Stop_Execution.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "jobExecutionName": "jobExecution1", "api-version": "2023-05-01" }, diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Stop_Multiple.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Stop_Multiple.json index 4534b50ac355..f083e180c3ce 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Stop_Multiple.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Job_Stop_Multiple.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "resourceGroupName": "rg", - "jobName": "testcontainerAppsJob0", + "jobName": "testcontainerappsjob0", "jobExecutionName": { "value": [ { diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Jobs_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Jobs_ListByResourceGroup.json index a781372cc5c0..601b9941b8b3 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Jobs_ListByResourceGroup.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Jobs_ListByResourceGroup.json @@ -10,8 +10,8 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -29,21 +29,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] @@ -51,8 +51,8 @@ } }, { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", - "name": "testcontainerAppsJob1", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob1", + "name": "testcontainerappsjob1", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -71,11 +71,11 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob1:v4", + "image": "repo/testcontainerappsjob1:v4", "name": "testcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], @@ -84,8 +84,8 @@ "image": "repo/testinitcontainerAppsJob1:v4", "name": "testinitcontainerApp0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Jobs_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Jobs_ListBySubscription.json index 8ce1f1291466..dfd551145b0d 100644 --- a/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Jobs_ListBySubscription.json +++ b/specification/app/resource-manager/Microsoft.App/stable/2023-05-01/examples/Jobs_ListBySubscription.json @@ -9,8 +9,8 @@ "body": { "value": [ { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", - "name": "testcontainerAppsJob0", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob0", + "name": "testcontainerappsjob0", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -28,21 +28,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob0:v4", - "name": "testcontainerAppsJob0", + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob0:v4", + "image": "repo/testcontainerappsjob0:v4", "name": "testinitcontainerAppsJob0", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] @@ -50,8 +50,8 @@ } }, { - "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", - "name": "testcontainerAppsJob1", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerappsjob1", + "name": "testcontainerappsjob1", "type": "Microsoft.App/jobs", "location": "East US", "properties": { @@ -70,21 +70,21 @@ "template": { "containers": [ { - "image": "repo/testcontainerAppsJob1:v4", - "name": "testcontainerAppsJob1", + "image": "repo/testcontainerappsjob1:v4", + "name": "testcontainerappsjob1", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ], "initContainers": [ { - "image": "repo/testcontainerAppsJob1:v4", + "image": "repo/testcontainerappsjob1:v4", "name": "testinitcontainerAppsJob1", "resources": { - "cpu": 0.2, - "memory": "100Mi" + "cpu": 0.5, + "memory": "1Gi" } } ] diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/arcSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/arcSettings.json new file mode 100644 index 000000000000..678e1e7cc7c4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/arcSettings.json @@ -0,0 +1,819 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/arcSettings": { + "get": { + "operationId": "ArcSettings_ListByCluster", + "description": "Get ArcSetting resources of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ArcSetting resources by HCI Cluster": { + "$ref": "./examples/ListArcSettingsByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}": { + "get": { + "operationId": "ArcSettings_Get", + "description": "Get ArcSetting resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ArcSetting": { + "$ref": "./examples/GetArcSetting.json" + } + } + }, + "put": { + "operationId": "ArcSettings_Create", + "description": "Create ArcSetting for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "name": "arcSetting", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArcSetting" + }, + "description": "Parameters supplied to the Create ArcSetting resource for this HCI cluster." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create ArcSetting": { + "$ref": "./examples/PutArcSetting.json" + } + } + }, + "patch": { + "operationId": "ArcSettings_Update", + "description": "Update ArcSettings for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "name": "arcSetting", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArcSettingsPatch" + }, + "description": "ArcSettings parameters that needs to be updated" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch ArcSetting": { + "$ref": "./examples/PatchArcSetting.json" + } + } + }, + "delete": { + "operationId": "ArcSettings_Delete", + "description": "Delete ArcSetting resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete ArcSetting": { + "$ref": "./examples/DeleteArcSetting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/generatePassword": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_GeneratePassword", + "description": "Generate password for arc settings.", + "x-ms-examples": { + "Generate Password": { + "$ref": "./examples/GeneratePassword.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PasswordCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/createArcIdentity": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_CreateIdentity", + "description": "Create Aad identity for arc settings.", + "x-ms-examples": { + "Create Arc Identity": { + "$ref": "./examples/CreateArcIdentity.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcIdentityResponse" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/consentAndInstallDefaultExtensions": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_ConsentAndInstallDefaultExtensions", + "description": "Add consent time for default extensions and initiate extensions installation", + "x-ms-examples": { + "Consent And Install Default Extensions": { + "$ref": "./examples/ConsentAndInstallDefaultExtensions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/initializeDisableProcess": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_InitializeDisableProcess", + "description": "Initializes ARC Disable process on the cluster", + "x-ms-examples": { + "Trigger ARC Disable": { + "$ref": "./examples/InitializeDisableProcess.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "ArcSettingList": { + "description": "List of ArcSetting proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of ArcSetting proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ArcSetting" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ArcSettingsPatch": { + "description": "ArcSetting details to update.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "ArcSettings properties.", + "$ref": "#/definitions/ArcSettingsPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcSettingsPatchProperties": { + "description": "ArcSettings properties.", + "type": "object", + "properties": { + "connectivityProperties": { + "description": "contains connectivity related configuration for ARC resources", + "type": "object", + "items": { + "$ref": "#/definitions/ArcConnectivityProperties" + } + } + } + }, + "ArcSetting": { + "description": "ArcSetting details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "ArcSetting properties.", + "$ref": "#/definitions/ArcSettingProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcSettingProperties": { + "description": "ArcSetting properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the ArcSetting proxy resource.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Failed", + "Canceled", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "arcInstanceResourceGroup": { + "description": "The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.", + "type": "string" + }, + "arcApplicationClientId": { + "description": "App id of arc AAD identity.", + "type": "string" + }, + "arcApplicationTenantId": { + "description": "Tenant id of arc AAD identity.", + "type": "string" + }, + "arcServicePrincipalObjectId": { + "description": "Object id of arc AAD service principal.", + "type": "string" + }, + "arcApplicationObjectId": { + "description": "Object id of arc AAD identity.", + "type": "string" + }, + "aggregateState": { + "description": "Aggregate state of Arc agent across the nodes in this HCI cluster.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "ArcSettingAggregateState", + "modelAsString": true + }, + "readOnly": true + }, + "perNodeDetails": { + "description": "State of Arc agent in each of the nodes.", + "type": "array", + "items": { + "$ref": "#/definitions/PerNodeState" + }, + "readOnly": true + }, + "connectivityProperties": { + "description": "contains connectivity related configuration for ARC resources", + "type": "object", + "items": { + "$ref": "#/definitions/ArcConnectivityProperties" + } + }, + "defaultExtensions": { + "description": "Properties for each of the default extensions category", + "type": "array", + "items": { + "$ref": "#/definitions/DefaultExtensionDetails" + }, + "x-ms-identifiers": [ + "category" + ], + "readOnly": true + } + } + }, + "PerNodeState": { + "description": "Status of Arc agent for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the Node in HCI Cluster" + }, + "arcInstance": { + "description": "Fully qualified resource ID for the Arc agent of this node.", + "type": "string", + "readOnly": true + }, + "arcNodeServicePrincipalObjectId": { + "description": "The service principal id of the arc for server node", + "type": "string", + "readOnly": true + }, + "state": { + "description": "State of Arc agent in this node.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "NodeArcState", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "DefaultExtensionDetails": { + "description": "Properties for a particular default extension category.", + "type": "object", + "properties": { + "category": { + "description": "Default extension category", + "type": "string", + "readOnly": true + }, + "consentTime": { + "description": "Consent time for extension category", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "ArcConnectivityProperties": { + "description": "Connectivity related configuration required by arc server.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "True indicates ARC connectivity is enabled" + }, + "serviceConfigurations": { + "type": "array", + "description": "Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'.", + "items": { + "$ref": "#/definitions/ServiceConfiguration" + }, + "x-ms-identifiers": [ + "serviceName" + ] + } + }, + "additionalProperties": false + }, + "ServiceConfiguration": { + "type": "object", + "description": "Service configuration details", + "required": [ + "serviceName", + "port" + ], + "properties": { + "serviceName": { + "type": "string", + "description": "Name of the service.", + "enum": [ + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The port on which service is enabled." + } + } + }, + "PasswordCredential": { + "type": "object", + "properties": { + "secretText": { + "type": "string" + }, + "keyId": { + "type": "string" + }, + "startDateTime": { + "type": "string", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "readOnly": true + }, + "ArcIdentityResponse": { + "description": "ArcIdentity details.", + "type": "object", + "properties": { + "properties": { + "description": "ArcIdentity properties.", + "$ref": "#/definitions/ArcIdentityResponseProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcIdentityResponseProperties": { + "type": "object", + "properties": { + "arcApplicationClientId": { + "type": "string" + }, + "arcApplicationTenantId": { + "type": "string" + }, + "arcServicePrincipalObjectId": { + "type": "string" + }, + "arcApplicationObjectId": { + "type": "string" + } + }, + "additionalProperties": false, + "readOnly": true + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ArcSettingNameParameter": { + "name": "arcSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proxy resource holding details of HCI ArcSetting information.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/clusters.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/clusters.json new file mode 100644 index 000000000000..4cd95faa2399 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/clusters.json @@ -0,0 +1,1096 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListBySubscription", + "x-ms-examples": { + "List clusters in a given subscription": { + "$ref": "./examples/ListClustersBySubscription.json" + } + }, + "description": "List all HCI clusters in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "x-ms-examples": { + "List clusters in a given resource group": { + "$ref": "./examples/ListClustersByResourceGroup.json" + } + }, + "description": "List all HCI clusters in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Get", + "x-ms-examples": { + "Get cluster": { + "$ref": "./examples/GetCluster.json" + } + }, + "description": "Get HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Create", + "x-ms-examples": { + "Create cluster": { + "$ref": "./examples/CreateCluster.json" + } + }, + "description": "Create an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "cluster", + "in": "body", + "description": "Details of the HCI cluster.", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Update", + "x-ms-examples": { + "Update cluster": { + "$ref": "./examples/UpdateCluster.json" + } + }, + "description": "Update an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "cluster", + "in": "body", + "description": "Details of the HCI cluster.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Delete", + "x-ms-examples": { + "Delete cluster": { + "$ref": "./examples/DeleteCluster.json" + } + }, + "description": "Delete an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/uploadCertificate": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_UploadCertificate", + "x-ms-examples": { + "Upload certificate": { + "$ref": "./examples/UploadCertificate.json" + } + }, + "description": "Upload certificate.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "uploadCertificateRequest", + "in": "body", + "description": "Upload certificate request.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadCertificateRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/createClusterIdentity": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_CreateIdentity", + "description": "Create cluster identity.", + "x-ms-examples": { + "Create cluster Identity": { + "$ref": "./examples/CreateClusterIdentity.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterIdentityResponse" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/extendSoftwareAssuranceBenefit": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_ExtendSoftwareAssuranceBenefit", + "description": "Extends Software Assurance Benefit to a cluster", + "x-ms-examples": { + "Create cluster Identity": { + "$ref": "./examples/ExtendSoftwareAssuranceBenefit.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "softwareAssuranceChangeRequest", + "in": "body", + "description": "Software Assurance Change Request Payload", + "required": true, + "schema": { + "$ref": "#/definitions/SoftwareAssuranceChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ClusterList": { + "description": "List of clusters.", + "type": "object", + "properties": { + "value": { + "description": "List of clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Cluster": { + "description": "Cluster details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Identity of Cluster resource", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Cluster properties.", + "$ref": "#/definitions/ClusterProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterPatch": { + "description": "Cluster details to update.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "description": "Identity of Cluster resource", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Cluster properties.", + "$ref": "#/definitions/ClusterPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterProperties": { + "description": "Cluster properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "NotSpecified", + "Creating", + "Updating", + "Deleting", + "Moving", + "Deleted", + "PartiallySucceeded", + "InProgress", + "DisableInProgress", + "Connected", + "PartiallyConnected", + "Disconnected" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "status": { + "description": "Status of the cluster agent.", + "type": "string", + "enum": [ + "NotYetRegistered", + "ConnectedRecently", + "NotConnectedRecently", + "Disconnected", + "Error", + "NotSpecified", + "ValidationInProgress", + "ValidationSuccess", + "ValidationFailed", + "DeploymentInProgress", + "DeploymentFailed", + "DeploymentSuccess" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + }, + "readOnly": true + }, + "connectivityStatus": { + "description": "Overall connectivity status for the cluster resource.", + "type": "string", + "enum": [ + "NotYetRegistered", + "Connected", + "NotConnectedRecently", + "PartiallyConnected", + "Disconnected", + "NotSpecified" + ], + "x-ms-enum": { + "name": "ConnectivityStatus", + "modelAsString": true + }, + "readOnly": true + }, + "cloudId": { + "description": "Unique, immutable resource id.", + "type": "string", + "readOnly": true + }, + "cloudManagementEndpoint": { + "description": "Endpoint configured for management from the Azure portal.", + "type": "string" + }, + "aadClientId": { + "description": "App id of cluster AAD identity.", + "type": "string" + }, + "aadTenantId": { + "description": "Tenant id of cluster AAD identity.", + "type": "string" + }, + "aadApplicationObjectId": { + "description": "Object id of cluster AAD identity.", + "type": "string" + }, + "aadServicePrincipalObjectId": { + "description": "Id of cluster identity service principal.", + "type": "string" + }, + "softwareAssuranceProperties": { + "description": "Software Assurance properties of the cluster.", + "$ref": "#/definitions/SoftwareAssuranceProperties" + }, + "desiredProperties": { + "description": "Desired properties of the cluster.", + "$ref": "#/definitions/ClusterDesiredProperties" + }, + "reportedProperties": { + "description": "Properties reported by cluster agent.", + "$ref": "#/definitions/ClusterReportedProperties", + "readOnly": true + }, + "isolatedVmAttestationConfiguration": { + "description": "Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.", + "$ref": "#/definitions/IsolatedVmAttestationConfiguration", + "readOnly": true + }, + "trialDaysRemaining": { + "description": "Number of days remaining in the trial period.", + "type": "number", + "readOnly": true + }, + "billingModel": { + "description": "Type of billing applied to the resource.", + "type": "string", + "readOnly": true + }, + "registrationTimestamp": { + "description": "First cluster sync timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastSyncTimestamp": { + "description": "Most recent cluster sync timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastBillingTimestamp": { + "description": "Most recent billing meter timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "serviceEndpoint": { + "description": "Region specific DataPath Endpoint of the cluster.", + "type": "string", + "readOnly": true + }, + "resourceProviderObjectId": { + "description": "Object id of RP Service Principal", + "type": "string", + "readOnly": true + } + } + }, + "ClusterPatchProperties": { + "description": "Cluster properties.", + "type": "object", + "properties": { + "cloudManagementEndpoint": { + "description": "Endpoint configured for management from the Azure portal", + "type": "string" + }, + "aadClientId": { + "description": "App id of cluster AAD identity.", + "type": "string" + }, + "aadTenantId": { + "description": "Tenant id of cluster AAD identity.", + "type": "string" + }, + "desiredProperties": { + "description": "Desired properties of the cluster.", + "$ref": "#/definitions/ClusterDesiredProperties" + } + } + }, + "SoftwareAssuranceProperties": { + "description": "Software Assurance properties of the cluster.", + "type": "object", + "properties": { + "softwareAssuranceStatus": { + "description": "Status of the Software Assurance for the cluster.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceStatus", + "modelAsString": true + }, + "readOnly": true + }, + "softwareAssuranceIntent": { + "description": "Customer Intent for Software Assurance Benefit.", + "type": "string", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceIntent", + "modelAsString": true + } + }, + "lastUpdated": { + "description": "TimeStamp denoting the latest SA benefit applicability is validated.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "IsolatedVmAttestationConfiguration": { + "description": "Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.", + "type": "object", + "properties": { + "attestationResourceId": { + "description": "Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Attestation/attestationProviders", + "scopes": [ + "Tenant" + ] + } + ] + }, + "readOnly": true + }, + "relyingPartyServiceEndpoint": { + "description": "Region specific endpoint for relying party service.", + "type": "string", + "readOnly": true + }, + "attestationServiceEndpoint": { + "description": "Region specific endpoint for Microsoft Azure Attestation service for the cluster", + "type": "string", + "readOnly": true + } + } + }, + "ClusterDesiredProperties": { + "description": "Desired properties of the cluster.", + "type": "object", + "properties": { + "windowsServerSubscription": { + "description": "Desired state of Windows Server Subscription.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WindowsServerSubscription", + "modelAsString": true + } + }, + "diagnosticLevel": { + "description": "Desired level of diagnostic data emitted by the cluster.", + "type": "string", + "enum": [ + "Off", + "Basic", + "Enhanced" + ], + "x-ms-enum": { + "name": "DiagnosticLevel", + "modelAsString": true + } + } + } + }, + "ClusterReportedProperties": { + "description": "Properties reported by cluster agent.", + "type": "object", + "properties": { + "clusterName": { + "description": "Name of the on-prem cluster connected to this resource.", + "type": "string", + "readOnly": true + }, + "clusterId": { + "description": "Unique id generated by the on-prem cluster.", + "type": "string", + "readOnly": true + }, + "clusterVersion": { + "description": "Version of the cluster software.", + "type": "string", + "readOnly": true + }, + "nodes": { + "description": "List of nodes reported by the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterNode" + }, + "readOnly": true + }, + "lastUpdated": { + "description": "Last time the cluster reported the data.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "imdsAttestation": { + "description": "IMDS attestation status of the cluster.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ImdsAttestation", + "modelAsString": true + }, + "readOnly": true + }, + "diagnosticLevel": { + "description": "Level of diagnostic data emitted by the cluster.", + "type": "string", + "enum": [ + "Off", + "Basic", + "Enhanced" + ], + "x-ms-enum": { + "name": "DiagnosticLevel", + "modelAsString": true + } + }, + "supportedCapabilities": { + "description": "Capabilities supported by the cluster.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "clusterType": { + "description": "The node type of all the nodes of the cluster.", + "type": "string", + "enum": [ + "FirstParty", + "ThirdParty" + ], + "x-ms-enum": { + "name": "ClusterNodeType", + "modelAsString": true + }, + "readOnly": true + }, + "manufacturer": { + "description": "The manufacturer of all the nodes of the cluster.", + "type": "string", + "readOnly": true + }, + "oemActivation": { + "description": "OEM activation status of the cluster.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "OemActivation", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "ClusterNode": { + "description": "Cluster node details.", + "type": "object", + "properties": { + "name": { + "description": "Name of the cluster node.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the node in the cluster.", + "type": "number", + "readOnly": true + }, + "windowsServerSubscription": { + "description": "State of Windows Server Subscription.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WindowsServerSubscription", + "modelAsString": true + }, + "readOnly": true + }, + "nodeType": { + "description": "Type of the cluster node hardware.", + "type": "string", + "enum": [ + "FirstParty", + "ThirdParty" + ], + "x-ms-enum": { + "name": "ClusterNodeType", + "modelAsString": true + }, + "readOnly": true + }, + "ehcResourceId": { + "description": "Edge Hardware Center Resource Id", + "type": "string", + "readOnly": true + }, + "manufacturer": { + "description": "Manufacturer of the cluster node hardware.", + "type": "string", + "readOnly": true + }, + "model": { + "description": "Model name of the cluster node hardware.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "Operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "osVersion": { + "description": "Version of the operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "osDisplayVersion": { + "description": "Display version of the operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "serialNumber": { + "description": "Immutable id of the cluster node.", + "type": "string", + "readOnly": true + }, + "coreCount": { + "description": "Number of physical cores on the cluster node.", + "type": "number", + "readOnly": true + }, + "memoryInGiB": { + "description": "Total available memory on the cluster node (in GiB).", + "type": "number", + "readOnly": true + }, + "lastLicensingTimestamp": { + "description": "Most recent licensing timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "oemActivation": { + "description": "OEM activation status of the node.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "OemActivation", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "RawCertificateData": { + "type": "object", + "properties": { + "certificates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "UploadCertificateRequest": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData" + } + }, + "additionalProperties": false + }, + "SoftwareAssuranceChangeRequestProperties": { + "type": "object", + "properties": { + "softwareAssuranceIntent": { + "type": "string", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceIntent", + "modelAsString": true + } + } + }, + "additionalProperties": false + }, + "SoftwareAssuranceChangeRequest": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SoftwareAssuranceChangeRequestProperties" + } + }, + "additionalProperties": false + }, + "ClusterIdentityResponse": { + "description": "Cluster Identity details.", + "type": "object", + "properties": { + "properties": { + "description": "Cluster identity properties.", + "$ref": "#/definitions/ClusterIdentityResponseProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterIdentityResponseProperties": { + "type": "object", + "properties": { + "aadClientId": { + "type": "string" + }, + "aadTenantId": { + "type": "string" + }, + "aadServicePrincipalObjectId": { + "type": "string" + }, + "aadApplicationObjectId": { + "type": "string" + } + }, + "additionalProperties": false, + "readOnly": true + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/deploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/deploymentSettings.json new file mode 100644 index 000000000000..23dde3c77534 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/deploymentSettings.json @@ -0,0 +1,1007 @@ +{ + "swagger": "2.0", + "info": { + "title": "Deployment Settings", + "version": "2023-11-01-preview", + "description": "Azure Stack HCI Deployment Settings." + }, + "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": "DeploymentSettings" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings": { + "get": { + "operationId": "DeploymentSettings_ListByClusters", + "tags": [ + "DeploymentSettings" + ], + "description": "List DeploymentSetting resources by Clusters", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentSettingListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Deployment Settings": { + "$ref": "./examples/ListDeploymentSettingsByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}": { + "get": { + "operationId": "DeploymentSettings_Get", + "tags": [ + "DeploymentSettings" + ], + "description": "Get a DeploymentSetting", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "deploymentSettingsName", + "in": "path", + "description": "Name of Deployment Setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentSetting" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Deployment Settings": { + "$ref": "./examples/GetDeploymentSettings.json" + } + } + }, + "put": { + "operationId": "DeploymentSettings_CreateOrUpdate", + "tags": [ + "DeploymentSettings" + ], + "description": "Create a DeploymentSetting", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "deploymentSettingsName", + "in": "path", + "description": "Name of Deployment Setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentSetting" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DeploymentSetting' update operation succeeded", + "schema": { + "$ref": "#/definitions/DeploymentSetting" + } + }, + "201": { + "description": "Resource 'DeploymentSetting' create operation succeeded", + "schema": { + "$ref": "#/definitions/DeploymentSetting" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Deployment Settings": { + "$ref": "./examples/PutDeploymentSettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DeploymentSettings_Delete", + "tags": [ + "DeploymentSettings" + ], + "description": "Delete a DeploymentSetting", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "deploymentSettingsName", + "in": "path", + "description": "Name of Deployment Setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Deployment Settings": { + "$ref": "./examples/DeleteDeploymentSettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AdapterPropertyOverrides": { + "type": "object", + "description": "The AdapterPropertyOverrides of a cluster.", + "properties": { + "jumboPacket": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "networkDirect": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "networkDirectTechnology": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE'" + } + } + }, + "DeploymentCluster": { + "type": "object", + "description": "AzureStackHCI Cluster deployment properties.", + "properties": { + "name": { + "type": "string", + "description": "The cluster name provided when preparing Active Directory." + }, + "witnessType": { + "type": "string", + "description": "Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. " + }, + "witnessPath": { + "type": "string", + "description": "Specify the fileshare path for the local witness for your Azure Stack HCI cluster." + }, + "cloudAccountName": { + "type": "string", + "description": "Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster." + }, + "azureServiceEndpoint": { + "type": "string", + "description": "For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net." + } + } + }, + "DeploymentConfiguration": { + "type": "object", + "description": "Deployment Configuration", + "properties": { + "version": { + "type": "string", + "description": "deployment template version " + }, + "scaleUnits": { + "type": "array", + "description": "Scale units will contains list of deployment data", + "items": { + "$ref": "#/definitions/ScaleUnits" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "scaleUnits" + ] + }, + "DeploymentData": { + "type": "object", + "description": "The Deployment data of AzureStackHCI Cluster.", + "properties": { + "securitySettings": { + "$ref": "#/definitions/DeploymentSecuritySettings", + "description": "SecuritySettings to deploy AzureStackHCI Cluster." + }, + "observability": { + "$ref": "#/definitions/Observability", + "description": "Observability config to deploy AzureStackHCI Cluster." + }, + "cluster": { + "$ref": "#/definitions/DeploymentCluster", + "description": "Observability config to deploy AzureStackHCI Cluster." + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage config to deploy AzureStackHCI Cluster." + }, + "namingPrefix": { + "type": "string", + "description": "naming prefix to deploy cluster.", + "pattern": "^[a-zA-Z0-9-]{1,8}$" + }, + "domainFqdn": { + "type": "string", + "description": "FQDN to deploy cluster" + }, + "infrastructureNetwork": { + "type": "array", + "description": "InfrastructureNetwork config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/InfrastructureNetwork" + }, + "x-ms-identifiers": [] + }, + "physicalNodes": { + "type": "array", + "description": "list of physical nodes config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/PhysicalNodes" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hostNetwork": { + "$ref": "#/definitions/HostNetwork", + "description": "HostNetwork config to deploy AzureStackHCI Cluster." + }, + "adouPath": { + "type": "string", + "description": "The path to the Active Directory Organizational Unit container object prepared for the deployment. " + }, + "secretsLocation": { + "type": "string", + "description": "The URI to the keyvault / secret store." + }, + "optionalServices": { + "$ref": "#/definitions/OptionalServices", + "description": "OptionalServices config to deploy AzureStackHCI Cluster." + } + } + }, + "DeploymentMode": { + "type": "string", + "description": "The deployment mode for cluster deployment.", + "enum": [ + "Validate", + "Deploy" + ], + "default": "Deploy", + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": true, + "values": [ + { + "name": "Validate", + "value": "Validate", + "description": "Validate deployment settings for cluster." + }, + { + "name": "Deploy", + "value": "Deploy", + "description": "Deploy cluster using deployment settings." + } + ] + } + }, + "DeploymentSetting": { + "type": "object", + "description": "Edge device resource", + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentSettingsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeploymentSettingListResult": { + "type": "object", + "description": "The response of a DeploymentSetting list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DeploymentSetting items on this page", + "items": { + "$ref": "#/definitions/DeploymentSetting" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DeploymentSettingsProperties": { + "type": "object", + "description": "DeploymentSetting properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "DeploymentSetting provisioning state", + "readOnly": true + }, + "arcNodeResourceIds": { + "type": "array", + "description": "Azure resource ids of Arc machines to be part of cluster.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "deploymentMode": { + "$ref": "#/definitions/DeploymentMode", + "description": "The deployment mode for cluster deployment." + }, + "deploymentConfiguration": { + "$ref": "#/definitions/DeploymentConfiguration", + "description": "Scale units will contains list of deployment data", + "x-ms-identifiers": [] + }, + "reportedProperties": { + "$ref": "#/definitions/ReportedProperties", + "description": "Deployment Status reported from cluster.", + "readOnly": true + } + }, + "required": [ + "arcNodeResourceIds", + "deploymentMode", + "deploymentConfiguration" + ] + }, + "DeploymentStatus": { + "type": "object", + "description": "The DeploymentStatus of AzureStackHCI Cluster.", + "properties": { + "status": { + "type": "string", + "description": "Status of AzureStackHCI Cluster Deployment.", + "readOnly": true + }, + "steps": { + "type": "array", + "description": "List of steps of AzureStackHCI Cluster Deployment.", + "items": { + "$ref": "#/definitions/DeploymentStep" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "HostNetwork": { + "type": "object", + "description": "The HostNetwork of a cluster.", + "properties": { + "intents": { + "type": "array", + "description": "The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM.", + "items": { + "$ref": "#/definitions/Intents" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "storageNetworks": { + "type": "array", + "description": "List of StorageNetworks config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/StorageNetworks" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "storageConnectivitySwitchless": { + "type": "boolean", + "description": "Defines how the storage adapters between nodes are connected either switch or switch less..", + "default": false + }, + "enableStorageAutoIp": { + "type": "boolean", + "description": "Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically.", + "default": false + } + } + }, + "InfrastructureNetwork": { + "type": "object", + "description": "The InfrastructureNetwork of a AzureStackHCI Cluster.", + "properties": { + "subnetMask": { + "type": "string", + "description": "Subnet mask that matches the provided IP address space." + }, + "gateway": { + "type": "string", + "description": "Default gateway that should be used for the provided IP address space." + }, + "ipPools": { + "type": "array", + "description": "Range of IP addresses from which addresses are allocated for nodes within a subnet.", + "items": { + "$ref": "#/definitions/IpPools" + }, + "x-ms-identifiers": [] + }, + "dnsServers": { + "type": "array", + "description": "IPv4 address of the DNS servers in your environment.", + "items": { + "type": "string" + } + }, + "useDhcp": { + "type": "boolean", + "description": "Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required" + } + } + }, + "Intents": { + "type": "object", + "description": "The Intents of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network intent you wish to create." + }, + "trafficType": { + "type": "array", + "description": "List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'.", + "items": { + "type": "string" + } + }, + "adapter": { + "type": "array", + "description": "Array of network interfaces used for the network intent.", + "items": { + "type": "string" + } + }, + "overrideVirtualSwitchConfiguration": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "default": false + }, + "virtualSwitchConfigurationOverrides": { + "$ref": "#/definitions/VirtualSwitchConfigurationOverrides", + "description": "Set virtualSwitch ConfigurationOverrides for cluster." + }, + "overrideQosPolicy": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "default": false + }, + "qosPolicyOverrides": { + "$ref": "#/definitions/QosPolicyOverrides", + "description": "Set QoS PolicyOverrides for cluster." + }, + "overrideAdapterProperty": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "default": false + }, + "adapterPropertyOverrides": { + "$ref": "#/definitions/AdapterPropertyOverrides", + "description": "Set Adapter PropertyOverrides for cluster." + } + } + }, + "IpPools": { + "type": "object", + "description": "The dnsServers of a device.", + "properties": { + "startingAddress": { + "type": "string", + "description": "Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering." + }, + "endingAddress": { + "type": "string", + "description": "Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering." + } + } + }, + "Observability": { + "type": "object", + "description": "The Observability of AzureStackHCI Cluster.", + "properties": { + "streamingDataClient": { + "type": "boolean", + "description": "Enables telemetry data to be sent to Microsoft", + "default": true + }, + "euLocation": { + "type": "boolean", + "description": "Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU.", + "default": false + }, + "episodicDataUpload": { + "type": "boolean", + "description": "When set to true, collects log data to facilitate quicker issue resolution.", + "default": true + } + } + }, + "OptionalServices": { + "type": "object", + "description": "The OptionalServices of AzureStackHCI Cluster.", + "properties": { + "customLocation": { + "type": "string", + "description": "The name of custom location." + } + } + }, + "PhysicalNodes": { + "type": "object", + "description": "The PhysicalNodes of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "NETBIOS name of each physical server on your Azure Stack HCI cluster." + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address assigned to each physical server on your Azure Stack HCI cluster." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "NotSpecified", + "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": "NotSpecified", + "value": "NotSpecified", + "description": "The resource provision state is not specified" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The resource is being provisioned" + }, + { + "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 create request has been accepted" + } + ] + } + }, + "QosPolicyOverrides": { + "type": "object", + "description": "The QoSPolicyOverrides of a cluster.", + "properties": { + "priorityValue8021Action_Cluster": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "priorityValue8021Action_SMB": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "bandwidthPercentage_SMB": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + } + } + }, + "ReportedProperties": { + "type": "object", + "description": "The DeploymentStatus of AzureStackHCI Cluster.", + "properties": { + "validationStatus": { + "$ref": "#/definitions/ValidationStatus", + "description": "validation status of AzureStackHCI Cluster Deployment.", + "readOnly": true + }, + "deploymentStatus": { + "$ref": "#/definitions/DeploymentStatus", + "description": "Deployment status of AzureStackHCI Cluster Deployment.", + "readOnly": true + } + } + }, + "ScaleUnits": { + "type": "object", + "description": "Scale units will contains list of deployment data", + "properties": { + "deploymentData": { + "$ref": "#/definitions/DeploymentData", + "description": "Deployment Data to deploy AzureStackHCI Cluster." + } + }, + "required": [ + "deploymentData" + ], + "externalDocs": { + "description": "Deploy Azure Stack HCI using an existing configuration file", + "url": "https://learn.microsoft.com/en-us/azure-stack/hci/deploy/deployment-tool-existing-file" + } + }, + "DeploymentSecuritySettings": { + "type": "object", + "description": "The SecuritySettings of AzureStackHCI Cluster.", + "properties": { + "hvciProtection": { + "type": "boolean", + "description": "By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster.", + "default": true + }, + "drtmProtection": { + "type": "boolean", + "description": "By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent.", + "default": true + }, + "driftControlEnforced": { + "type": "boolean", + "description": "When set to true, the security baseline is re-applied regularly.", + "default": true + }, + "credentialGuardEnforced": { + "type": "boolean", + "description": "When set to true, Credential Guard is enabled.", + "default": false + }, + "smbSigningEnforced": { + "type": "boolean", + "description": "When set to true, the SMB default instance requires sign in for the client and server services.", + "default": true + }, + "smbClusterEncryption": { + "type": "boolean", + "description": "When set to true, cluster east-west traffic is encrypted.", + "default": false + }, + "sideChannelMitigationEnforced": { + "type": "boolean", + "description": "When set to true, all the side channel mitigations are enabled", + "default": true + }, + "bitlockerBootVolume": { + "type": "boolean", + "description": "When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ", + "default": true + }, + "bitlockerDataVolumes": { + "type": "boolean", + "description": "When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes.", + "default": true + }, + "wdacEnforced": { + "type": "boolean", + "description": "WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster.", + "default": true + } + } + }, + "DeploymentStep": { + "type": "object", + "description": "The Step of AzureStackHCI Cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of step.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of step.", + "readOnly": true + }, + "fullStepIndex": { + "type": "string", + "description": "FullStepIndex of step.", + "readOnly": true + }, + "startTimeUtc": { + "type": "string", + "description": "Start time of step.", + "readOnly": true + }, + "endTimeUtc": { + "type": "string", + "description": "End time of step.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Status of step. Allowed values are 'Error', 'Success', 'InProgress'", + "readOnly": true + }, + "steps": { + "type": "array", + "description": "List of nested steps of AzureStackHCI Cluster Deployment.", + "items": { + "$ref": "#/definitions/DeploymentStep" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "exception": { + "type": "array", + "description": "List of exceptions in AzureStackHCI Cluster Deployment.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "Storage": { + "type": "object", + "description": "The Storage config of AzureStackHCI Cluster.", + "properties": { + "configurationMode": { + "type": "string", + "description": "By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage'", + "default": "Express" + } + } + }, + "StorageNetworks": { + "type": "object", + "description": "The StorageNetworks of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of the storage network." + }, + "networkAdapterName": { + "type": "string", + "description": "Name of the storage network adapter." + }, + "vlanId": { + "type": "string", + "description": "ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. " + } + } + }, + "ValidationStatus": { + "type": "object", + "description": "The ValidationStatus of AzureStackHCI Cluster.", + "properties": { + "status": { + "type": "string", + "description": "Status of AzureStackHCI Cluster Deployment.", + "readOnly": true + }, + "steps": { + "type": "array", + "description": "List of steps of AzureStackHCI Cluster Deployment.", + "items": { + "$ref": "#/definitions/DeploymentStep" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "VirtualSwitchConfigurationOverrides": { + "type": "object", + "description": "The VirtualSwitchConfigurationOverrides of a cluster.", + "properties": { + "enableIov": { + "type": "string", + "description": "Enable IoV for Virtual Switch" + }, + "loadBalancingAlgorithm": { + "type": "string", + "description": "Load Balancing Algorithm for Virtual Switch" + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/edgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/edgeDevices.json new file mode 100644 index 000000000000..6bd76c8747e4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/edgeDevices.json @@ -0,0 +1,562 @@ +{ + "swagger": "2.0", + "info": { + "title": "Edge Devices", + "version": "2023-11-01-preview", + "description": "Azure Arc-enabled Edge Device." + }, + "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": "EdgeDevices" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices": { + "get": { + "operationId": "EdgeDevices_List", + "tags": [ + "EdgeDevices" + ], + "description": "List EdgeDevice resources by parent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeDeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Edge Devices": { + "$ref": "./examples/ListEdgeDevices.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}": { + "get": { + "operationId": "EdgeDevices_Get", + "tags": [ + "EdgeDevices" + ], + "description": "Get a EdgeDevice", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeDevice" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Edge Device": { + "$ref": "./examples/GetEdgeDevices.json" + } + } + }, + "put": { + "operationId": "EdgeDevices_CreateOrUpdate", + "tags": [ + "EdgeDevices" + ], + "description": "Create a EdgeDevice", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeDevice" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EdgeDevice' update operation succeeded", + "schema": { + "$ref": "#/definitions/EdgeDevice" + } + }, + "201": { + "description": "Resource 'EdgeDevice' create operation succeeded", + "schema": { + "$ref": "#/definitions/EdgeDevice" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Edge Device": { + "$ref": "./examples/PutEdgeDevices.json" + } + } + }, + "delete": { + "operationId": "EdgeDevices_Delete", + "tags": [ + "EdgeDevices" + ], + "description": "Delete a EdgeDevice", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Edge Devices": { + "$ref": "./examples/DeleteEdgeDevices.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/validate": { + "post": { + "operationId": "EdgeDevices_Validate", + "tags": [ + "EdgeDevices" + ], + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "ValidateRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Validate Edge Devices": { + "$ref": "./examples/ValidateEdgeDevices.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "DeviceConfiguration": { + "type": "object", + "description": "The device Configuration of a device.", + "properties": { + "nicDetails": { + "type": "array", + "description": "NIC Details of device", + "items": { + "$ref": "#/definitions/NicDetail" + }, + "x-ms-identifiers": [] + }, + "deviceMetadata": { + "type": "string", + "description": "device metadata details." + } + }, + "required": [ + "nicDetails" + ] + }, + "EdgeDevice": { + "type": "object", + "description": "Edge device resource", + "properties": { + "properties": { + "$ref": "#/definitions/EdgeDeviceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "EdgeDeviceListResult": { + "type": "object", + "description": "The response of a EdgeDevice list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EdgeDevice items on this page", + "items": { + "$ref": "#/definitions/EdgeDevice" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EdgeDeviceProperties": { + "type": "object", + "description": "Edge Device properties", + "properties": { + "deviceConfiguration": { + "$ref": "#/definitions/DeviceConfiguration", + "description": "Device Configuration" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of edgeDevice resource", + "readOnly": true + } + }, + "required": [ + "deviceConfiguration" + ] + }, + "NicDetail": { + "type": "object", + "description": "The NIC Detail of a device.", + "properties": { + "adapterName": { + "type": "string", + "description": "Adapter Name of NIC" + }, + "interfaceDescription": { + "type": "string", + "description": "Interface Description of NIC" + }, + "componentId": { + "type": "string", + "description": "Component Id of NIC" + }, + "driverVersion": { + "type": "string", + "description": "Driver Version of NIC" + }, + "ip4Address": { + "type": "string", + "description": "Subnet Mask of NIC" + }, + "subnetMask": { + "type": "string", + "description": "Subnet Mask of NIC" + }, + "defaultGateway": { + "type": "string", + "description": "Default Gateway of NIC" + }, + "dnsServers": { + "type": "array", + "description": "DNS Servers for NIC", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "defaultIsolationId": { + "type": "string", + "description": "Default Isolation of Management NIC" + } + }, + "required": [ + "adapterName" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "NotSpecified", + "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": "NotSpecified", + "value": "NotSpecified", + "description": "The resource provision state is not specified" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The resource is being provisioned" + }, + { + "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 create request has been accepted" + } + ] + } + }, + "ValidateRequest": { + "type": "object", + "description": "The validate request for Edge Device.", + "properties": { + "edgeDeviceIds": { + "type": "array", + "description": "Node Ids against which, current node has to be validated.", + "items": { + "type": "string" + } + }, + "additionalInfo": { + "type": "string", + "description": "additional Info required for validation" + } + }, + "required": [ + "edgeDeviceIds" + ] + }, + "ValidateResponse": { + "type": "object", + "description": "An Accepted response with an Operation-Location header.", + "properties": { + "status": { + "type": "string", + "description": "edge device validation status", + "readOnly": true + } + } + } + }, + "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 + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ConsentAndInstallDefaultExtensions.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ConsentAndInstallDefaultExtensions.json new file mode 100644 index 000000000000..a105b26b30b4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ConsentAndInstallDefaultExtensions.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/CreateArcIdentity.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/CreateArcIdentity.json new file mode 100644 index 000000000000..f045cfa22dab --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/CreateArcIdentity.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "arcApplicationClientId": "7b93bf67-60ac-4909-a987-ac438e69f9ba", + "arcApplicationTenantId": "bdb2c88c-9cfd-4e19-927d-51e875f6912b", + "arcApplicationObjectId": "400bd05f-395f-45a6-ba75-72601df80107", + "arcServicePrincipalObjectId": "00cc4014-482e-4de9-9932-83415cc75f45" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/CreateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/CreateCluster.json new file mode 100644 index 000000000000..350f2285956e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/CreateCluster.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview", + "cluster": { + "location": "East US", + "properties": { + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "identity": { + "principalId": "87a834db-2e45-409e-911b-e16a44562ec3", + "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "type": "SystemAssigned" + }, + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "connectivityStatus": "NotYetRegistered", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Disabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "serviceEndpoint": "https://azurestackhci.azurefd.net/eastus" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/CreateClusterIdentity.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/CreateClusterIdentity.json new file mode 100644 index 000000000000..797ea4056610 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/CreateClusterIdentity.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "aadClientId": "7b93bf67-60ac-4909-a987-ac438e69f9ba", + "aadTenantId": "bdb2c88c-9cfd-4e19-927d-51e875f6912b", + "aadServicePrincipalObjectId": "400bd05f-395f-45a6-ba75-72601df80107", + "aadApplicationObjectId": "00cc4014-482e-4de9-9932-83415cc75f45" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteArcSetting.json new file mode 100644 index 000000000000..94035bfba8af --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteArcSetting.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteCluster.json new file mode 100644 index 000000000000..e439a0066025 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteCluster.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteDeploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteDeploymentSettings.json new file mode 100644 index 000000000000..1054657c6392 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteDeploymentSettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "deploymentSettingsName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteEdgeDevices.json new file mode 100644 index 000000000000..107d43092902 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteEdgeDevices.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteExtension.json new file mode 100644 index 000000000000..41c8d2e19909 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteExtension.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteSecuritySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteSecuritySettings.json new file mode 100644 index 000000000000..a2742108dd74 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteSecuritySettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "securitySettingsName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteUpdateRuns.json new file mode 100644 index 000000000000..28bab0c0de88 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteUpdateRuns.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteUpdateSummaries.json new file mode 100644 index 000000000000..9b130a43068b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteUpdateSummaries.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteUpdates.json new file mode 100644 index 000000000000..1296b42025fe --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/DeleteUpdates.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ExtendSoftwareAssuranceBenefit.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ExtendSoftwareAssuranceBenefit.json new file mode 100644 index 000000000000..b28b10a4cfd5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ExtendSoftwareAssuranceBenefit.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview", + "softwareAssuranceChangeRequest": { + "properties": { + "softwareAssuranceIntent": "Enable" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "softwareAssuranceProperties": { + "softwareAssuranceStatus": "Enabled", + "lastUpdated": "2022-08-18T22:01:12.4191603Z", + "softwareAssuranceIntent": "Enable" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "nodeType": "ThirdParty", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/Extensions_Upgrade.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/Extensions_Upgrade.json new file mode 100644 index 000000000000..a83a65b5b502 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/Extensions_Upgrade.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2023-11-01-preview", + "extensionUpgradeParameters": { + "targetVersion": "1.0.18062.0" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses", + "Retry-After": 200, + "Azure-AsyncOperation": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GeneratePassword.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GeneratePassword.json new file mode 100644 index 000000000000..bb807cc92c61 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GeneratePassword.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "secretText": "secretText", + "startDateTime": "2022-02-17T16:24:23.6264005+05:30", + "endDateTime": "2121-02-17T16:24:23.6264377+05:30", + "keyId": "00000000-2d47-4fb2-8ed2-fed71a5c197b" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetArcSetting.json new file mode 100644 index 000000000000..a75e4c44229f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetArcSetting.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "PartiallyConnected", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "arcNodeServicePrincipalObjectId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "state": "Connected" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "arcNodeServicePrincipalObjectId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "state": "Disconnected" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetCluster.json new file mode 100644 index 000000000000..de8939722b56 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetCluster.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "Connected", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "isolatedVmAttestationConfiguration": { + "attestationResourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testmaa", + "relyingPartyServiceEndpoint": "https://azurestackhci.azurefd.net/eastus", + "attestationServiceEndpoint": "https://dantestnoauth01.eus.attest.azure.net" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "oemActivation": "Disabled", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z", + "oemActivation": "Disabled" + }, + { + "name": "Node2", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z", + "oemActivation": "Disabled" + }, + { + "name": "Node3", + "id": 3, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z", + "oemActivation": "Disabled" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetDeploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetDeploymentSettings.json new file mode 100644 index 000000000000..969f01e1764f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetDeploymentSettings.json @@ -0,0 +1,211 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "deploymentSettingsName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5" + } + ], + "storageConnectivitySwitchless": true + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "optionalServices": { + "customLocation": "customLocationName" + } + } + } + ] + }, + "reportedProperties": { + "validationStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10" + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ] + } + ] + } + ] + }, + "deploymentStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10" + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ] + } + ] + } + ] + } + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetEdgeDevices.json new file mode 100644 index 000000000000..c93f790fdf19 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetEdgeDevices.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "deviceConfiguration": { + "nicDetails": [ + { + "adapterName": "ethernet", + "interfaceDescription": "NDIS 6.70 ", + "componentId": "VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} ", + "driverVersion": "10.0.20348.1547 ", + "ip4Address": "10.10.10.10", + "subnetMask": "255.255.255.0", + "defaultGateway": "10.10.10.1", + "dnsServers": [ + "100.10.10.1" + ], + "defaultIsolationId": "0" + } + ], + "deviceMetadata": "" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetExtension.json new file mode 100644 index 000000000000..961dffad91c6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetExtension.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "enableAutomaticUpgrade": true, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "Azure" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetOffer.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetOffer.json new file mode 100644 index 000000000000..1f02e28e4c71 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetOffer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetPublisher.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetPublisher.json new file mode 100644 index 000000000000..9da7c8632cfa --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetPublisher.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1", + "type": "Microsoft.AzureStackHCI/clusters/publishers", + "name": "publisher1" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetSecuritySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetSecuritySettings.json new file mode 100644 index 000000000000..d51499626a1a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetSecuritySettings.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "securitySettingsName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetSku.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetSku.json new file mode 100644 index 000000000000..acfcb4b7ff14 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetSku.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "skuName": "sku1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers/skus", + "name": "sku1", + "properties": { + "publisherId": "publisher1", + "offerId": "offer1", + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetUpdateRuns.json new file mode 100644 index 000000000000..0c24d706dd9b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetUpdateRuns.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetUpdateSummaries.json new file mode 100644 index 000000000000..29f426261025 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetUpdateSummaries.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetUpdates.json new file mode 100644 index 000000000000..94dfeb48f97c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/GetUpdates.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": "Microsoft.AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/InitializeDisableProcess.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/InitializeDisableProcess.json new file mode 100644 index 000000000000..81a0cf9f61a6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/InitializeDisableProcess.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses", + "Retry-After": 200, + "Azure-AsyncOperation": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListArcSettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListArcSettingsByCluster.json new file mode 100644 index 000000000000..98c691868555 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListArcSettingsByCluster.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "PartiallyConnected", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Connected" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Disconnected" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListClustersByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListClustersByResourceGroup.json new file mode 100644 index 000000000000..3e15cdd0508c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListClustersByResourceGroup.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster1", + "name": "myCluster1", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "connectivityStatus": "NotYetRegistered", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 29, + "billingModel": "Trial" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster2", + "name": "myCluster2", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "PartiallyConnected", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "oemActivation": "Disabled", + "nodes": [ + { + "name": "Node1", + "id": 0, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node2", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node3", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "oemActivation": "Disabled" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListClustersBySubscription.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListClustersBySubscription.json new file mode 100644 index 000000000000..48109a56cdee --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListClustersBySubscription.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg1/providers/Microsoft.AzureStackHCI/clusters/myCluster1", + "name": "myCluster1", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "connectivityStatus": "NotYetRegistered", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 29, + "billingModel": "Trial" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg2/providers/Microsoft.AzureStackHCI/clusters/myCluster2", + "name": "myCluster2", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "West US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "Connected", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "oemActivation": "Enabled", + "nodes": [ + { + "name": "Node1", + "id": 0, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node2", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node3", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "oemActivation": "Enabled" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListDeploymentSettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListDeploymentSettingsByCluster.json new file mode 100644 index 000000000000..1be23baf4730 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListDeploymentSettingsByCluster.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5" + } + ], + "storageConnectivitySwitchless": true + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "optionalServices": { + "customLocation": "customLocationName" + } + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListEdgeDevices.json new file mode 100644 index 000000000000..d7ce6709fe90 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListEdgeDevices.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "deviceConfiguration": { + "nicDetails": [ + { + "adapterName": "ethernet", + "interfaceDescription": "NDIS 6.70 ", + "componentId": "VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} ", + "driverVersion": "10.0.20348.1547 ", + "ip4Address": "10.10.10.10", + "subnetMask": "255.255.255.0", + "defaultGateway": "10.10.10.1", + "dnsServers": [ + "100.10.10.1" + ], + "defaultIsolationId": "0" + } + ], + "deviceMetadata": "" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListExtensionsByArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListExtensionsByArcSetting.json new file mode 100644 index 000000000000..52cfe4a702c9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListExtensionsByArcSetting.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallyConnected", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Connected" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Disconnected" + } + ], + "managedBy": "Azure" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/Extensions/SecurityExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.CustomScriptExtension", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "scriptLocation": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/SecurityExtension", + "state": "Succeeded" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/SecurityExtension", + "state": "Failed" + } + ], + "managedBy": "Azure" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListOffersByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListOffersByCluster.json new file mode 100644 index 000000000000..09a78cd8b3c1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListOffersByCluster.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListOffersByPublisher.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListOffersByPublisher.json new file mode 100644 index 000000000000..2680da844404 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListOffersByPublisher.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListOperations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListOperations.json new file mode 100644 index 000000000000..3b53c6ccfb03 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListOperations.json @@ -0,0 +1,453 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureStackHCI/Register/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Register", + "operation": "Registers the Azure Stack HCI Resource Provider", + "description": "Registers the subscription for the Azure Stack HCI resource provider and enables the creation of Azure Stack HCI resources." + } + }, + { + "name": "Microsoft.AzureStackHCI/Unregister/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Unregister", + "operation": "Unregisters the Azure Stack HCI Resource Provider", + "description": "Unregisters the subscription for the Azure Stack HCI resource provider." + } + }, + { + "name": "Microsoft.AzureStackHCI/Operations/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Operations", + "operation": "Gets/List operations resources", + "description": "Gets operations" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Gets/List cluster resources", + "description": "Gets clusters" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Create/update cluster resources", + "description": "Creates or updates a cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Deletes cluster resource", + "description": "Deletes cluster resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Gets/List arc resources", + "description": "Gets arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Create/Update arc resources", + "description": "Create or updates arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Delete arc resources", + "description": "Delete arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Gets/List extension resources of HCI cluster", + "description": "Gets extension resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Create/Update extension resources of HCI cluster", + "description": "Create or update extension resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Delete extension resources of HCI cluster", + "description": "Delete extension resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Restart/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Restarts virtual machine resource", + "description": "Restarts virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Start/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Starts virtual machine resource", + "description": "Starts virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Stop/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Stops virtual machine resource", + "description": "Stops virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Deletes virtual machine resource", + "description": "Deletes virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Creates/Updates virtual machine resource", + "description": "Creates/Updates virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Gets/Lists virtual machine resource", + "description": "Gets/Lists virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Deletes virtual networks resource", + "description": "Deletes virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Creates/Updates virtual networks resource", + "description": "Creates/Updates virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Gets/Lists virtual networks resource", + "description": "Gets/Lists virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Deletes virtual hard disk resource", + "description": "Deletes virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Creates/Updates virtual hard disk resource", + "description": "Creates/Updates virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Gets/Lists virtual hard disk resource", + "description": "Gets/Lists virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Deletes network interfaces resource", + "description": "Deletes network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Creates/Updates network interfaces resource", + "description": "Creates/Updates network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Gets/Lists network interfaces resource", + "description": "Gets/Lists network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Deletes gallery images resource", + "description": "Deletes gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Creates/Updates gallery images resource", + "description": "Creates/Updates gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Gets/Lists gallery images resource", + "description": "Gets/Lists gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/HybridIdentityMetadata/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/HybridIdentityMetadata", + "operation": "Gets/Lists virtual machine hybrid identity metadata proxy resource", + "description": "Gets/Lists virtual machine hybrid identity metadata proxy resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Gets/Lists virtual machine extensions resource", + "description": "Gets/Lists virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Creates/Updates virtual machine extensions resource", + "description": "Creates/Updates virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Deletes virtual machine extensions resource", + "description": "Deletes virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/RegisteredSubscriptions/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "RegisteredSubscriptions", + "operation": "Gets/Lists registered subscriptions", + "description": "Reads registered subscriptions" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Gets/List available updates for HCI cluster", + "description": "Gets available updates for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Create/Update updates resource of HCI cluster", + "description": "Create or update updates resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Delete updates resources of HCI cluster", + "description": "Delete updates resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Gets/List available update summaries for HCI cluster", + "description": "Gets available update summaries for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Create/Update update summaries resource of HCI cluster", + "description": "Create or update update summaries resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Delete updates resource summaries of HCI cluster", + "description": "Delete update summaries resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Gets/List available update runs for HCI cluster", + "description": "Gets available update runs for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Create/Update update runs resource of HCI cluster", + "description": "Create or update update runs resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Delete updates resource runs of HCI cluster", + "description": "Delete update runs resources of HCI cluster" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListPublishersByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListPublishersByCluster.json new file mode 100644 index 000000000000..682c469a0e1d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListPublishersByCluster.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1", + "type": "Microsoft.AzureStackHCI/clusters/publishers", + "name": "publisher1" + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListSecuritySettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListSecuritySettingsByCluster.json new file mode 100644 index 000000000000..3e8253a58430 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListSecuritySettingsByCluster.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListSkusByOffer.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListSkusByOffer.json new file mode 100644 index 000000000000..d7e2d55a1ce7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListSkusByOffer.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers/skus", + "name": "sku1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "offerId": "offer1", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListUpdateRuns.json new file mode 100644 index 000000000000..be58bd04aaf6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListUpdateRuns.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListUpdateSummaries.json new file mode 100644 index 000000000000..e6f1694b2e0a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListUpdateSummaries.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListUpdates.json new file mode 100644 index 000000000000..162f16119a98 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ListUpdates.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": " Microsoft. AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PatchArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PatchArcSetting.json new file mode 100644 index 000000000000..2bf66ba0973a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PatchArcSetting.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "arcSetting": { + "properties": { + "connectivityProperties": { + "enabled": true, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + } + } + }, + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "connectivityProperties": { + "enabled": true, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + }, + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PatchExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PatchExtension.json new file mode 100644 index 000000000000..ab04dcf250ac --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PatchExtension.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "extension": { + "properties": { + "extensionParameters": { + "typeHandlerVersion": "1.10", + "enableAutomaticUpgrade": false, + "settings": { + "workspaceId": "xx" + }, + "protectedSettings": { + "workspaceKey": "xx" + } + } + } + }, + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallyConnected", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Connected", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Disconnected", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PostUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PostUpdates.json new file mode 100644 index 000000000000..1cce89888a1c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PostUpdates.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutArcSetting.json new file mode 100644 index 000000000000..10aa50c5783f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutArcSetting.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "arcSetting": {}, + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutDeploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutDeploymentSettings.json new file mode 100644 index 000000000000..87268cae7ccf --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutDeploymentSettings.json @@ -0,0 +1,558 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "deploymentSettingsName": "default", + "api-version": "2023-11-01-preview", + "resource": { + "properties": { + "provisioningState": "Succeeded", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5" + } + ], + "storageConnectivitySwitchless": true + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "optionalServices": { + "customLocation": "customLocationName" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5" + } + ], + "storageConnectivitySwitchless": true + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "optionalServices": { + "customLocation": "customLocationName" + } + } + } + ] + }, + "reportedProperties": { + "validationStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + } + ] + } + ] + }, + "deploymentStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": null, + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": null, + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + } + ] + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5" + } + ], + "storageConnectivitySwitchless": true + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "optionalServices": { + "customLocation": "customLocationName" + } + } + } + ] + }, + "reportedProperties": { + "validationStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10" + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ] + } + ] + } + ] + }, + "deploymentStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + } + ] + } + ] + } + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutEdgeDevices.json new file mode 100644 index 000000000000..4e14e11196a3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutEdgeDevices.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2023-11-01-preview", + "resource": { + "properties": { + "deviceConfiguration": { + "nicDetails": [ + { + "adapterName": "ethernet", + "interfaceDescription": "NDIS 6.70 ", + "componentId": "VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} ", + "driverVersion": "10.0.20348.1547 ", + "ip4Address": "10.10.10.10", + "subnetMask": "255.255.255.0", + "defaultGateway": "10.10.10.1", + "dnsServers": [ + "100.10.10.1" + ], + "defaultIsolationId": "0" + } + ], + "deviceMetadata": "" + }, + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "deviceConfiguration": { + "nicDetails": [ + { + "adapterName": "ethernet", + "interfaceDescription": "NDIS 6.70 ", + "componentId": "VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} ", + "driverVersion": "10.0.20348.1547 ", + "ip4Address": "10.10.10.10", + "subnetMask": "255.255.255.0", + "defaultGateway": "10.10.10.1", + "dnsServers": [ + "100.10.10.1" + ], + "defaultIsolationId": "0" + } + ], + "deviceMetadata": "" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "deviceConfiguration": { + "nicDetails": [ + { + "adapterName": "ethernet", + "interfaceDescription": "NDIS 6.70 ", + "componentId": "VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} ", + "driverVersion": "10.0.20348.1547 ", + "ip4Address": "10.10.10.10", + "subnetMask": "255.255.255.0", + "defaultGateway": "10.10.10.1", + "dnsServers": [ + "100.10.10.1" + ], + "defaultIsolationId": "0" + } + ], + "deviceMetadata": "" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutExtension.json new file mode 100644 index 000000000000..359ff7131870 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutExtension.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "extension": { + "properties": { + "extensionParameters": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "MicrosoftMonitoringAgent", + "enableAutomaticUpgrade": false, + "settings": { + "workspaceId": "xx" + }, + "protectedSettings": { + "workspaceKey": "xx" + } + } + } + }, + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutSecuritySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutSecuritySettings.json new file mode 100644 index 000000000000..cc225597eefa --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutSecuritySettings.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "securitySettingsName": "default", + "api-version": "2023-11-01-preview", + "resource": { + "properties": { + "securedCoreComplianceAssignment": "Audit" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutUpdateRuns.json new file mode 100644 index 000000000000..06c2e9223cc6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutUpdateRuns.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2023-11-01-preview", + "updateRunsProperties": { + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutUpdateSummaries.json new file mode 100644 index 000000000000..115c7721571d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutUpdateSummaries.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-11-01-preview", + "updateLocationProperties": { + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "lastChecked": "2022-04-07T18:04:07Z", + "currentVersion": "4.2203.2.32", + "lastUpdated": "2022-04-06T14:08:18.254Z", + "state": "AppliedSuccessfully" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutUpdates.json new file mode 100644 index 000000000000..4e74f471c12c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/PutUpdates.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-11-01-preview", + "updateProperties": { + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": "Microsoft.AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/UpdateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/UpdateCluster.json new file mode 100644 index 000000000000..713ac7b48554 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/UpdateCluster.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview", + "cluster": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "identity": { + "principalId": "87a834db-2e45-409e-911b-e16a44562ec3", + "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "Connected", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "isolatedVmAttestationConfiguration": { + "attestationResourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testmaa", + "relyingPartyServiceEndpoint": "https://azurestackhci.azurefd.net/eastus", + "attestationServiceEndpoint": "https://dantestnoauth01.eus.attest.azure.net" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + }, + { + "name": "Node2", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + }, + { + "name": "Node3", + "id": 3, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/UploadCertificate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/UploadCertificate.json new file mode 100644 index 000000000000..09d7d9b2043b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/UploadCertificate.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-11-01-preview", + "uploadCertificateRequest": { + "properties": { + "certificates": [ + "base64cert", + "base64cert" + ] + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ValidateEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ValidateEdgeDevices.json new file mode 100644 index 000000000000..62b919918f2f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/examples/ValidateEdgeDevices.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2023-11-01-preview", + "ValidateRequest": { + "edgeDeviceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/edgeDevices/default", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/edgeDevices/default" + ], + "additionalInfo": "test" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "status": "success" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/extensions.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/extensions.json new file mode 100644 index 000000000000..f19fef3771f4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/extensions.json @@ -0,0 +1,707 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions": { + "get": { + "operationId": "Extensions_ListByArcSetting", + "description": "List all Extensions under ArcSetting resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExtensionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Extensions under ArcSetting resource": { + "$ref": "./examples/ListExtensionsByArcSetting.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}": { + "get": { + "operationId": "Extensions_Get", + "description": "Get particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ArcSettings Extension": { + "$ref": "./examples/GetExtension.json" + } + } + }, + "put": { + "operationId": "Extensions_Create", + "description": "Create Extension for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extension", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Extension" + }, + "description": "Details of the Machine Extension to be created." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create Arc Extension": { + "$ref": "./examples/PutExtension.json" + } + } + }, + "patch": { + "operationId": "Extensions_Update", + "description": "Update Extension for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extension", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExtensionPatch" + }, + "description": "Details of the Machine Extension to be created." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "Update Arc Extension": { + "$ref": "./examples/PatchExtension.json" + } + } + }, + "delete": { + "operationId": "Extensions_Delete", + "description": "Delete particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "OK" + }, + "204": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete Arc Extension": { + "$ref": "./examples/DeleteExtension.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}/upgrade": { + "post": { + "operationId": "Extensions_Upgrade", + "description": "Upgrade a particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extensionUpgradeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExtensionUpgradeParameters" + }, + "description": "Parameters supplied to the Upgrade Extensions operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Upgrade Machine Extensions": { + "$ref": "./examples/Extensions_Upgrade.json" + } + } + } + } + }, + "definitions": { + "Extension": { + "description": "Details of a particular extension in HCI Cluster.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Describes Machine Extension Properties.", + "$ref": "#/definitions/ExtensionProperties", + "x-ms-client-flatten": true + } + } + }, + "ExtensionPatch": { + "description": "Extension Details to update", + "type": "object", + "properties": { + "properties": { + "description": "Describes Machine Extension Properties that can be updated.", + "$ref": "#/definitions/ExtensionPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ExtensionProperties": { + "description": "Status of Arc Extension for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Extension proxy resource.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Failed", + "Canceled", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "extensionParameters": { + "description": "Parameters specific to this extension type.", + "$ref": "#/definitions/ExtensionParameters", + "x-ms-client-flatten": true + }, + "aggregateState": { + "description": "Aggregate state of Arc Extensions across the nodes in this HCI cluster.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "UpgradeFailedRollbackSucceeded" + ], + "x-ms-enum": { + "name": "ExtensionAggregateState", + "modelAsString": true + }, + "readOnly": true + }, + "perNodeExtensionDetails": { + "description": "State of Arc Extension in each of the nodes.", + "type": "array", + "items": { + "$ref": "#/definitions/PerNodeExtensionState" + }, + "readOnly": true + }, + "managedBy": { + "description": "Indicates if the extension is managed by azure or the user.", + "type": "string", + "enum": [ + "Azure", + "User" + ], + "x-ms-enum": { + "name": "ExtensionManagedBy", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "ExtensionPatchProperties": { + "description": "Describes Machine Extension Properties that can be updated.", + "type": "object", + "properties": { + "extensionParameters": { + "description": "Describes the properties of a Machine Extension that can be updated.", + "$ref": "#/definitions/ExtensionPatchParameters" + } + } + }, + "ExtensionPatchParameters": { + "description": "Describes the properties of a Machine Extension that can be updated.", + "type": "object", + "properties": { + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler. Latest version would be used if not specified." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings (may contain secrets).", + "x-ms-secret": true + } + } + }, + "PerNodeExtensionState": { + "description": "Status of Arc Extension for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "name": { + "description": "Name of the node in HCI Cluster.", + "type": "string", + "readOnly": true + }, + "extension": { + "description": "Fully qualified resource ID for the particular Arc Extension on this node.", + "type": "string", + "readOnly": true + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler.", + "readOnly": true + }, + "state": { + "description": "State of Arc Extension in this node.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "NodeExtensionState", + "modelAsString": true + }, + "readOnly": true + }, + "instanceView": { + "$ref": "#/definitions/ExtensionInstanceView", + "description": "The extension instance view.", + "readOnly": true + } + } + }, + "ExtensionList": { + "description": "List of Extensions in HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Extensions in HCI cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/Extension" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ExtensionParameters": { + "description": "Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute.", + "type": "object", + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "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. Latest version would be used if not specified." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings (may contain secrets).", + "x-ms-secret": true + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + } + } + }, + "ExtensionInstanceView": { + "type": "object", + "description": "Describes the Extension Instance View.", + "properties": { + "name": { + "type": "string", + "description": "The extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"MicrosoftMonitoringAgent\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "type": "object", + "description": "Instance view status.", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + } + } + } + }, + "ExtensionUpgradeParameters": { + "type": "object", + "description": "Describes the parameters for Extension upgrade.", + "properties": { + "targetVersion": { + "type": "string", + "description": "Extension Upgrade Target Version." + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ArcSettingNameParameter": { + "name": "arcSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proxy resource holding details of HCI ArcSetting information.", + "x-ms-parameter-location": "method" + }, + "ExtensionNameParameter": { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/offers.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/offers.json new file mode 100644 index 000000000000..7c876b4e3694 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/offers.json @@ -0,0 +1,302 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers": { + "get": { + "operationId": "Offers_ListByPublisher", + "description": "List Offers available for a publisher within the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Offer resources by publisher for the HCI Cluster": { + "$ref": "./examples/ListOffersByPublisher.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/offers": { + "get": { + "operationId": "Offers_ListByCluster", + "description": "List Offers available across publishers for the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Offer resources by HCI Cluster": { + "$ref": "./examples/ListOffersByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}": { + "get": { + "operationId": "Offers_Get", + "description": "Get Offer resource details within a publisher of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Offer": { + "$ref": "./examples/GetOffer.json" + } + } + } + } + }, + "definitions": { + "OfferList": { + "description": "List of Offer proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Offer proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Offer" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Offer": { + "description": "Offer details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Offer properties.", + "$ref": "#/definitions/OfferProperties", + "x-ms-client-flatten": true + } + } + }, + "OfferProperties": { + "description": "Publisher properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Identifier of the Publisher for the offer" + }, + "content": { + "type": "string", + "description": "JSON serialized catalog content of the offer" + }, + "contentVersion": { + "type": "string", + "description": "The API version of the catalog service used to serve the catalog content" + }, + "skuMappings": { + "type": "array", + "description": "Array of SKU mappings", + "items": { + "$ref": "#/definitions/SkuMappings" + }, + "x-ms-identifiers": [] + } + } + }, + "SkuMappings": { + "description": "SKU Mapping details.", + "type": "object", + "properties": { + "catalogPlanId": { + "type": "string", + "description": "Identifier of the CatalogPlan for the sku" + }, + "marketplaceSkuId": { + "type": "string", + "description": "Identifier for the sku" + }, + "marketplaceSkuVersions": { + "type": "array", + "description": "Array of SKU versions available", + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "OfferNameParameter": { + "name": "offerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the offer available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "ODataExpandParameter": { + "name": "$expand", + "in": "query", + "description": "Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/operations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/operations.json new file mode 100644 index 000000000000..b2dca6625684 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/operations.json @@ -0,0 +1,73 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "Create cluster": { + "$ref": "./examples/ListOperations.json" + } + }, + "description": "List all available Microsoft.AzureStackHCI provider operations", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/publishers.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/publishers.json new file mode 100644 index 000000000000..0ccc27b1d55a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/publishers.json @@ -0,0 +1,188 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/publishers": { + "get": { + "operationId": "Publishers_ListByCluster", + "description": "List Publishers available for the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublisherList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Publisher resources by HCI Cluster": { + "$ref": "./examples/ListPublishersByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}": { + "get": { + "operationId": "Publishers_Get", + "description": "Get Publisher resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Publisher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Publisher": { + "$ref": "./examples/GetPublisher.json" + } + } + } + } + }, + "definitions": { + "PublisherList": { + "description": "List of Publisher proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Publisher proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Publisher" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Publisher": { + "description": "Publisher details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Publisher properties.", + "$ref": "#/definitions/PublisherProperties", + "x-ms-client-flatten": true + } + } + }, + "PublisherProperties": { + "description": "Publisher properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/securitySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/securitySettings.json new file mode 100644 index 000000000000..3a6c2176d6fb --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/securitySettings.json @@ -0,0 +1,492 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureStackHCI", + "version": "2023-11-01-preview", + "description": "Azure Stack HCI cluster security settings." + }, + "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": "SecuritySettings" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings": { + "get": { + "operationId": "SecuritySettings_ListByClusters", + "tags": [ + "SecuritySettings" + ], + "description": "List SecuritySetting resources by 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/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecuritySettingListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Security Settings": { + "$ref": "./examples/ListSecuritySettingsByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings/{securitySettingsName}": { + "get": { + "operationId": "SecuritySettings_Get", + "tags": [ + "SecuritySettings" + ], + "description": "Get a SecuritySetting", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "securitySettingsName", + "in": "path", + "description": "Name of security setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecuritySetting" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Security Settings": { + "$ref": "./examples/GetSecuritySettings.json" + } + } + }, + "put": { + "operationId": "SecuritySettings_CreateOrUpdate", + "tags": [ + "SecuritySettings" + ], + "description": "Create a security setting", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "securitySettingsName", + "in": "path", + "description": "Name of security setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SecuritySetting" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SecuritySetting' update operation succeeded", + "schema": { + "$ref": "#/definitions/SecuritySetting" + } + }, + "201": { + "description": "Resource 'SecuritySetting' create operation succeeded", + "schema": { + "$ref": "#/definitions/SecuritySetting" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create Security Settings": { + "$ref": "./examples/PutSecuritySettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SecuritySettings_Delete", + "tags": [ + "SecuritySettings" + ], + "description": "Delete a SecuritySetting", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "securitySettingsName", + "in": "path", + "description": "Name of security setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Security Settings": { + "$ref": "./examples/DeleteSecuritySettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ComplianceAssignmentType": { + "type": "string", + "description": "Represents the compliance assignment type of a resource.", + "enum": [ + "Audit", + "ApplyAndAutoCorrect" + ], + "x-ms-enum": { + "name": "ComplianceAssignmentType", + "modelAsString": true, + "values": [ + { + "name": "Audit", + "value": "Audit", + "description": "Report on the state of the machine, but don't make changes." + }, + { + "name": "ApplyAndAutoCorrect", + "value": "ApplyAndAutoCorrect", + "description": "Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation." + } + ] + } + }, + "ComplianceStatus": { + "type": "string", + "description": "Represents the compliance status of a resource.", + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ], + "x-ms-enum": { + "name": "ComplianceStatus", + "modelAsString": true, + "values": [ + { + "name": "Compliant", + "value": "Compliant", + "description": "The resource is compliant" + }, + { + "name": "NonCompliant", + "value": "NonCompliant", + "description": "The resource is non-compliant" + }, + { + "name": "Pending", + "value": "Pending", + "description": "The resource compliance status is pending" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + } + }, + "SecurityComplianceStatus": { + "type": "object", + "description": "Security compliance properties of the resource", + "properties": { + "securedCoreCompliance": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether HCI hosts meets secured-core server requirements.", + "readOnly": true + }, + "wdacCompliance": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether HCI hosts have enforced consistent Windows Defender Application Control.", + "readOnly": true + }, + "dataAtRestEncrypted": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes.", + "readOnly": true + }, + "dataInTransitProtected": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether HCI cluster has data in-transit protection.", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Time in UTC when compliance status was last updated.", + "readOnly": true + } + } + }, + "SecurityProperties": { + "type": "object", + "description": "Security properties of the resource", + "properties": { + "securedCoreComplianceAssignment": { + "$ref": "#/definitions/ComplianceAssignmentType", + "description": "Secured Core Compliance Assignment", + "default": "Audit" + }, + "securityComplianceStatus": { + "$ref": "#/definitions/SecurityComplianceStatus", + "description": "Security Compliance Status", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SecuritySetting": { + "type": "object", + "description": "Security settings proxy resource", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "SecuritySettingListResult": { + "type": "object", + "description": "The response of a SecuritySetting list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SecuritySetting items on this page", + "items": { + "$ref": "#/definitions/SecuritySetting" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/skus.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/skus.json new file mode 100644 index 000000000000..f35d542a13d5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/skus.json @@ -0,0 +1,275 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus": { + "get": { + "operationId": "Skus_ListByOffer", + "description": "List Skus available for a offer within the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List SKU resources by offer for the HCI Cluster": { + "$ref": "./examples/ListSkusByOffer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}": { + "get": { + "operationId": "Skus_Get", + "description": "Get SKU resource details within a offer of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "#/parameters/SkuNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Sku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Sku": { + "$ref": "./examples/GetSku.json" + } + } + } + } + }, + "definitions": { + "SkuList": { + "description": "List of SKU proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of SKU proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Sku": { + "description": "Sku details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SKU properties.", + "$ref": "#/definitions/SkuProperties", + "x-ms-client-flatten": true + } + } + }, + "SkuProperties": { + "description": "SKU properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Identifier of the Publisher for the offer" + }, + "offerId": { + "type": "string", + "description": "Identifier of the Offer for the sku" + }, + "content": { + "type": "string", + "description": "JSON serialized catalog content of the sku offer" + }, + "contentVersion": { + "type": "string", + "description": "The API version of the catalog service used to serve the catalog content" + }, + "skuMappings": { + "type": "array", + "description": "Array of SKU mappings", + "items": { + "$ref": "#/definitions/SkuMappings" + }, + "x-ms-identifiers": [] + } + } + }, + "SkuMappings": { + "description": "SKU Mapping details.", + "type": "object", + "properties": { + "catalogPlanId": { + "type": "string", + "description": "Identifier of the CatalogPlan for the sku" + }, + "marketplaceSkuId": { + "type": "string", + "description": "Identifier for the sku" + }, + "marketplaceSkuVersions": { + "type": "array", + "description": "Array of SKU versions available", + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "OfferNameParameter": { + "name": "offerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the offer available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "SkuNameParameter": { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SKU available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "ODataExpandParameter": { + "name": "$expand", + "in": "query", + "description": "Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/updateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/updateRuns.json new file mode 100644 index 000000000000..0429b4bf2777 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/updateRuns.json @@ -0,0 +1,408 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns": { + "get": { + "operationId": "UpdateRuns_List", + "description": "List all Update runs for a specified update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Update runs under cluster resource": { + "$ref": "./examples/ListUpdateRuns.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}": { + "delete": { + "operationId": "UpdateRuns_Delete", + "description": "Delete specified Update Run", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdateRuns.json" + } + } + }, + "put": { + "operationId": "UpdateRuns_Put", + "description": "Put Update runs for a specified update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateRunsProperties", + "in": "body", + "description": "Properties of the updateRuns object", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateRun" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update runs under cluster resource": { + "$ref": "./examples/PutUpdateRuns.json" + } + } + }, + "get": { + "operationId": "UpdateRuns_Get", + "description": "Get the Update run for a specified update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update runs under cluster resource": { + "$ref": "./examples/GetUpdateRuns.json" + } + } + } + } + }, + "definitions": { + "UpdateRunList": { + "description": "List of Update runs", + "type": "object", + "properties": { + "value": { + "description": "List of Update runs", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateRun" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateRun": { + "description": "Details of an Update run", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Describes Update Run Properties.", + "$ref": "#/definitions/UpdateRunProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateRunProperties": { + "description": "Details of an Update run", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the UpdateRuns proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "timeStarted": { + "description": "Timestamp of the update run was started.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedTime": { + "description": "Timestamp of the most recently completed step in the update run.", + "type": "string", + "format": "date-time" + }, + "duration": { + "description": "Duration of the update run.", + "type": "string" + }, + "state": { + "description": "State of the update run.", + "type": "string", + "enum": [ + "Unknown", + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "updateRunPropertiesState", + "modelAsString": true + } + }, + "progress": { + "description": "Progress representation of the update run steps.", + "$ref": "#/definitions/Step", + "x-ms-client-flatten": true + } + } + }, + "Step": { + "description": "Progress representation of the update run steps.", + "type": "object", + "properties": { + "name": { + "description": "Name of the step.", + "type": "string" + }, + "description": { + "description": "More detailed description of the step.", + "type": "string" + }, + "errorMessage": { + "description": "Error message, specified if the step is in a failed state.", + "type": "string" + }, + "status": { + "description": "Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.", + "type": "string" + }, + "startTimeUtc": { + "description": "When the step started, or empty if it has not started executing.", + "type": "string", + "format": "date-time" + }, + "endTimeUtc": { + "description": "When the step reached a terminal state.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedTimeUtc": { + "description": "Completion time of this step or the last completed sub-step.", + "type": "string", + "format": "date-time" + }, + "steps": { + "description": "Recursive model for child steps of this step.", + "type": "array", + "items": { + "$ref": "#/definitions/Step" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "UpdateNameParameter": { + "name": "updateName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update", + "x-ms-parameter-location": "method" + }, + "UpdateRunNameParameter": { + "name": "updateRunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update Run", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/updateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/updateSummaries.json new file mode 100644 index 000000000000..97c68f16ea71 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/updateSummaries.json @@ -0,0 +1,487 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/updateSummaries": { + "get": { + "operationId": "UpdateSummaries_List", + "description": "List all Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummariesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update summaries under cluster resource": { + "$ref": "./examples/ListUpdateSummaries.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default": { + "delete": { + "operationId": "UpdateSummaries_Delete", + "description": "Delete Update Summaries", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdateSummaries.json" + } + } + }, + "put": { + "operationId": "UpdateSummaries_Put", + "description": "Put Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateLocationProperties", + "in": "body", + "description": "Properties of the UpdateSummaries resource", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put Update summaries under cluster resource": { + "$ref": "./examples/PutUpdateSummaries.json" + } + } + }, + "get": { + "operationId": "UpdateSummaries_Get", + "description": "Get all Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update summaries under cluster resource": { + "$ref": "./examples/GetUpdateSummaries.json" + } + } + } + } + }, + "definitions": { + "UpdateSummariesList": { + "description": "List of Update Summaries", + "type": "object", + "properties": { + "value": { + "description": "List of Update Summaries", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateSummaries" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateSummaries": { + "description": "Get the update summaries for the cluster", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Update summaries properties", + "type": "object", + "$ref": "#/definitions/UpdateSummariesProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateSummariesProperties": { + "description": "Properties of Update summaries", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the UpdateSummaries proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "oemFamily": { + "description": "OEM family name.", + "type": "string" + }, + "hardwareModel": { + "description": "Name of the hardware model.", + "type": "string" + }, + "packageVersions": { + "description": "Current version of each updatable component.", + "type": "array", + "items": { + "$ref": "#/definitions/PackageVersionInfo" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "version" + ] + }, + "currentVersion": { + "description": "Current Solution Bundle version of the stamp.", + "type": "string" + }, + "lastUpdated": { + "description": "Last time an update installation completed successfully.", + "type": "string", + "format": "date-time" + }, + "lastChecked": { + "description": "Last time the update service successfully checked for updates", + "type": "string", + "format": "date-time" + }, + "healthState": { + "description": "Overall health state for update-specific health checks.", + "type": "object", + "$ref": "#/definitions/HealthState", + "x-ms-client-flatten": true + }, + "healthCheckResult": { + "description": "An array of pre-check result objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PrecheckResult" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "name" + ] + }, + "healthCheckDate": { + "description": "Last time the package-specific checks were run.", + "type": "string", + "format": "date-time" + }, + "state": { + "description": "Overall update state of the stamp.", + "type": "string", + "enum": [ + "Unknown", + "AppliedSuccessfully", + "UpdateAvailable", + "UpdateInProgress", + "UpdateFailed", + "NeedsAttention", + "PreparationInProgress", + "PreparationFailed" + ], + "x-ms-enum": { + "name": "updateSummariesPropertiesState", + "modelAsString": true + } + } + } + }, + "PackageVersionInfo": { + "description": "Current version of each updatable component.", + "type": "object", + "properties": { + "packageType": { + "description": "Package type", + "type": "string" + }, + "version": { + "description": "Package version", + "type": "string" + }, + "lastUpdated": { + "description": "Last time this component was updated.", + "type": "string", + "format": "date-time" + } + } + }, + "HealthState": { + "type": "string", + "enum": [ + "Unknown", + "Success", + "Failure", + "Warning", + "Error", + "InProgress" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true + } + }, + "PrecheckResult": { + "type": "object", + "properties": { + "name": { + "description": "Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.", + "type": "string" + }, + "displayName": { + "description": "The health check DisplayName localized of the individual test executed.", + "type": "string" + }, + "tags": { + "description": "Key-value pairs that allow grouping/filtering individual tests.", + "type": "object", + "properties": { + "key": { + "description": "Key that allow grouping/filtering individual tests.", + "type": "string" + }, + "value": { + "description": "Value of the key that allow grouping/filtering individual tests.", + "type": "string" + } + } + }, + "title": { + "description": "User-facing name; one or more sentences indicating the direct issue.", + "type": "string" + }, + "status": { + "description": "The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "severity": { + "description": "Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity.", + "type": "string", + "enum": [ + "Critical", + "Warning", + "Informational", + "Hidden" + ], + "x-ms-enum": { + "name": "severity", + "modelAsString": true + } + }, + "description": { + "description": "Detailed overview of the issue and what impact the issue has on the stamp.", + "type": "string" + }, + "remediation": { + "description": "Set of steps that can be taken to resolve the issue found.", + "type": "string" + }, + "targetResourceID": { + "description": "The unique identifier for the affected resource (such as a node or drive).", + "type": "string" + }, + "targetResourceName": { + "description": "The name of the affected resource.", + "type": "string" + }, + "timestamp": { + "description": "The Time in which the HealthCheck was called.", + "type": "string", + "format": "date-time" + }, + "additionalData": { + "description": "Property bag of key value pairs for additional information.", + "type": "string" + }, + "healthCheckSource": { + "description": "The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).", + "type": "string" + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/updates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/updates.json new file mode 100644 index 000000000000..67179d459c4a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2023-11-01-preview/updates.json @@ -0,0 +1,660 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/apply": { + "post": { + "operationId": "Updates_Post", + "description": "Apply Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "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/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List available updates": { + "$ref": "./examples/PostUpdates.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates": { + "get": { + "operationId": "Updates_List", + "description": "List all Updates", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List available updates": { + "$ref": "./examples/ListUpdates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}": { + "delete": { + "operationId": "Updates_Delete", + "description": "Delete specified Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdates.json" + } + } + }, + "put": { + "operationId": "Updates_Put", + "description": "Put specified Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateProperties", + "in": "body", + "description": "Properties of the Updates object", + "required": true, + "schema": { + "$ref": "#/definitions/Update" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Update" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put a specific update": { + "$ref": "./examples/PutUpdates.json" + } + } + }, + "get": { + "operationId": "Updates_Get", + "description": "Get specified Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Update" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a specific update": { + "$ref": "./examples/GetUpdates.json" + } + } + } + } + }, + "definitions": { + "UpdateList": { + "description": "List of Updates", + "type": "object", + "properties": { + "value": { + "description": "List of Updates", + "type": "array", + "items": { + "$ref": "#/definitions/Update" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdatePrerequisite": { + "description": "If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.", + "type": "object", + "properties": { + "updateType": { + "description": "Updatable component type.", + "type": "string" + }, + "version": { + "description": "Version of the prerequisite.", + "type": "string" + }, + "packageName": { + "description": "Friendly name of the prerequisite.", + "type": "string" + } + } + }, + "Update": { + "description": "Update details", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Update properties", + "type": "object", + "$ref": "#/definitions/UpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateProperties": { + "description": "Details of a singular Update in HCI Cluster", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Updates proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "installedDate": { + "description": "Date that the update was installed.", + "type": "string", + "format": "date-time" + }, + "description": { + "description": "Description of the update.", + "type": "string" + }, + "state": { + "description": "State of the update as it relates to this stamp.", + "type": "string", + "enum": [ + "HasPrerequisite", + "Obsolete", + "Ready", + "NotApplicableBecauseAnotherUpdateIsInProgress", + "Preparing", + "Installing", + "Installed", + "PreparationFailed", + "InstallationFailed", + "Invalid", + "Recalled", + "Downloading", + "DownloadFailed", + "HealthChecking", + "HealthCheckFailed", + "ReadyToInstall", + "ScanInProgress", + "ScanFailed", + "AdditionalContentRequired" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "prerequisites": { + "description": "If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdatePrerequisite" + }, + "x-ms-identifiers": [ + "packageName" + ] + }, + "componentVersions": { + "description": "An array of component versions for a Solution Bundle update, and an empty array otherwise. ", + "type": "array", + "items": { + "$ref": "#/definitions/PackageVersionInfo" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "version" + ] + }, + "rebootRequired": { + "type": "object", + "$ref": "#/definitions/RebootRequirement", + "x-ms-client-flatten": true + }, + "healthState": { + "description": "Overall health state for update-specific health checks.", + "type": "object", + "$ref": "#/definitions/HealthState", + "x-ms-client-flatten": true + }, + "healthCheckResult": { + "description": "An array of PrecheckResult objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PrecheckResult" + }, + "x-ms-client-flatten": true + }, + "healthCheckDate": { + "description": "Last time the package-specific checks were run.", + "type": "string", + "format": "date-time" + }, + "packagePath": { + "description": "Path where the update package is available.", + "type": "string" + }, + "packageSizeInMb": { + "description": "Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.", + "type": "number" + }, + "displayName": { + "description": "Display name of the Update", + "type": "string" + }, + "version": { + "description": "Version of the update.", + "type": "string" + }, + "publisher": { + "description": "Publisher of the update package.", + "type": "string" + }, + "releaseLink": { + "description": "Link to release notes for the update.", + "type": "string" + }, + "availabilityType": { + "description": "Indicates the way the update content can be downloaded.", + "type": "string", + "enum": [ + "Local", + "Online", + "Notify" + ], + "x-ms-enum": { + "name": "availabilityType", + "modelAsString": true + } + }, + "packageType": { + "description": "Customer-visible type of the update.", + "type": "string" + }, + "additionalProperties": { + "description": "Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.", + "type": "string" + }, + "updateStateProperties": { + "description": "Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.", + "type": "object", + "$ref": "#/definitions/UpdateStateProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateStateProperties": { + "description": "Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.", + "type": "object", + "properties": { + "progressPercentage": { + "description": "Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.", + "type": "number" + }, + "notifyMessage": { + "description": "Brief message with instructions for updates of AvailabilityType Notify.", + "type": "string" + } + } + }, + "PackageVersionInfo": { + "description": "Current version of each updatable component.", + "type": "object", + "properties": { + "packageType": { + "description": "Package type", + "type": "string" + }, + "version": { + "description": "Package version", + "type": "string" + }, + "lastUpdated": { + "description": "Last time this component was updated.", + "type": "string", + "format": "date-time" + } + } + }, + "RebootRequirement": { + "type": "string", + "enum": [ + "Unknown", + "True", + "False" + ], + "x-ms-enum": { + "name": "RebootRequirement", + "modelAsString": true + } + }, + "HealthState": { + "type": "string", + "enum": [ + "Unknown", + "Success", + "Failure", + "Warning", + "Error", + "InProgress" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true + } + }, + "PrecheckResult": { + "type": "object", + "properties": { + "name": { + "description": "Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.", + "type": "string" + }, + "displayName": { + "description": "The health check DisplayName localized of the individual test executed.", + "type": "string" + }, + "tags": { + "description": "Key-value pairs that allow grouping/filtering individual tests.", + "type": "object", + "properties": { + "key": { + "description": "Key that allow grouping/filtering individual tests.", + "type": "string" + }, + "value": { + "description": "Value of the key that allow grouping/filtering individual tests.", + "type": "string" + } + } + }, + "title": { + "description": "User-facing name; one or more sentences indicating the direct issue.", + "type": "string" + }, + "status": { + "description": "The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "severity": { + "description": "Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity.", + "type": "string", + "enum": [ + "Critical", + "Warning", + "Informational", + "Hidden" + ], + "x-ms-enum": { + "name": "severity", + "modelAsString": true + } + }, + "description": { + "description": "Detailed overview of the issue and what impact the issue has on the stamp.", + "type": "string" + }, + "remediation": { + "description": "Set of steps that can be taken to resolve the issue found.", + "type": "string" + }, + "targetResourceID": { + "description": "The unique identifier for the affected resource (such as a node or drive).", + "type": "string" + }, + "targetResourceName": { + "description": "The name of the affected resource.", + "type": "string" + }, + "timestamp": { + "description": "The Time in which the HealthCheck was called.", + "type": "string", + "format": "date-time" + }, + "additionalData": { + "description": "Property bag of key value pairs for additional information.", + "type": "string" + }, + "healthCheckSource": { + "description": "The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).", + "type": "string" + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "UpdateNameParameter": { + "name": "updateName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/readme.md b/specification/azurestackhci/resource-manager/readme.md index 2fb6cd5c0821..3d0dbad3c8a9 100644 --- a/specification/azurestackhci/resource-manager/readme.md +++ b/specification/azurestackhci/resource-manager/readme.md @@ -29,7 +29,7 @@ title: AzureStackHCIClient description: Azure Stack HCI management service openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2023-09 +tag: package-preview-2023-11 ``` ## Suppression @@ -59,6 +59,7 @@ directive: - updateSummaries.json - deploymentSettings.json - edgeDevices.json + - securitySettings.json reason: Microsoft.AzureStackHCI is the correct name for our RP. suppressions: - code: PathResourceProviderNamePascalCase @@ -77,11 +78,32 @@ suppressions: reason: We have a dependency on other team which is already using these values, changing it will break backward compatibility. ``` + +### Tag: package-preview-2023-11 + +These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-11' +input-file: + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/arcSettings.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/clusters.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/deploymentSettings.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/edgeDevices.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/extensions.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/offers.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/operations.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/publishers.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/securitySettings.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/skus.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/updateRuns.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/updateSummaries.json + - Microsoft.AzureStackHCI/preview/2023-11-01-preview/updates.json +``` ### Tag: package-preview-2023-09 These settings apply only when `--tag=package-preview-2023-09` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-09' +``` yaml $(tag) == 'package-preview-2023-09' input-file: - Microsoft.AzureStackHCI/preview/2023-09-01-preview/common.json - Microsoft.AzureStackHCI/preview/2023-09-01-preview/galleryImages.json @@ -92,11 +114,12 @@ input-file: - Microsoft.AzureStackHCI/preview/2023-09-01-preview/virtualHardDisks.json - Microsoft.AzureStackHCI/preview/2023-09-01-preview/virtualMachineInstances.json ``` + ### Tag: package-preview-2023-08 These settings apply only when `--tag=package-preview-2023-08` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-08' +``` yaml $(tag) == 'package-preview-2023-08' input-file: - Microsoft.AzureStackHCI/preview/2023-08-01-preview/arcSettings.json - Microsoft.AzureStackHCI/preview/2023-08-01-preview/clusters.json @@ -111,11 +134,12 @@ input-file: - Microsoft.AzureStackHCI/preview/2023-08-01-preview/deploymentSettings.json - Microsoft.AzureStackHCI/preview/2023-08-01-preview/edgeDevices.json ``` + ### Tag: package-2023-08 These settings apply only when `--tag=package-2023-08` is specified on the command line. -```yaml $(tag) == 'package-2023-08' +``` yaml $(tag) == 'package-2023-08' input-file: - Microsoft.AzureStackHCI/stable/2023-08-01/arcSettings.json - Microsoft.AzureStackHCI/stable/2023-08-01/clusters.json @@ -128,6 +152,7 @@ input-file: - Microsoft.AzureStackHCI/stable/2023-08-01/updateSummaries.json - Microsoft.AzureStackHCI/stable/2023-08-01/updates.json ``` + ### Tag: package-preview-2023-07 These settings apply only when `--tag=package-preview-2023-07` is specified on the command line. diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/baremetalinfrastructure.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/baremetalinfrastructure.json new file mode 100644 index 000000000000..b84ee9d6b8e0 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/baremetalinfrastructure.json @@ -0,0 +1,1291 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "bareMetalInfrastructureClient", + "description": "The Bare Metal Infrastructure Management client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Bare Metal Instances", + "description": "Handle Operations for Compute Bare Metal Instances." + }, + { + "name": "Bare Metal Storage Instances", + "description": "Handle Operations for Storage Bare Metal Instances." + }, + { + "name": "Common", + "description": "Handle Common Operations across Bare Metal Infrastructure (Compute, and Storage)" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/start": { + "post": { + "tags": [ + "Bare Metal Instances" + ], + "summary": "Start a Bare Metal Instance.", + "description": "The operation to start an Azure Bare Metal instance", + "operationId": "AzureBareMetalInstances_Start", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start an Azure Bare Metal instance": { + "$ref": "./examples/AzureBareMetalInstances_Start.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "Accepted. The response indicates that the existing Bare Metal Instance is now turning on and includes a 'Location' header to query the operation result.", + "headers": { + "location": { + "type": "string", + "description": "URL to track the operation status of the Microsoft Bare Metal Infrastructure in the specified location." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/restart": { + "post": { + "tags": [ + "Bare Metal Instances" + ], + "summary": "Restart a Bare Metal Instance.", + "description": "The operation to restart an Azure Bare Metal Instance", + "operationId": "AzureBareMetalInstances_Restart", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Restart an Azure Bare Metal Instance": { + "$ref": "./examples/AzureBareMetalInstances_Restart.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + }, + { + "$ref": "#/parameters/ForcePowerManagementOperationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "Accepted. The response indicates that the existing Bare Metal Instance is now restarting and includes a 'Location' header to query the operation result.", + "headers": { + "location": { + "type": "string", + "description": "URL to track the operation status of the Microsoft Bare Metal Infrastructure in the specified location." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/shutdown": { + "post": { + "tags": [ + "Bare Metal Instances" + ], + "summary": "Shutdown a Bare Metal Instance.", + "description": "The operation to shutdown an Azure Bare Metal Instance", + "operationId": "AzureBareMetalInstances_Shutdown", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Shutdown an Azure Bare Metal Instance": { + "$ref": "./examples/AzureBareMetalInstances_Shutdown.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "Accepted. The response indicates that the existing Bare Metal Instance is now turning off and includes a 'Location' header to query the operation result.", + "headers": { + "location": { + "type": "string", + "description": "URL to track the operation status of the Microsoft Bare Metal Infrastructure in the specified location." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances": { + "get": { + "tags": [ + "Bare Metal Instances" + ], + "operationId": "AzureBareMetalInstances_ListBySubscription", + "summary": "Returns a list of Azure Bare Metal Instances in the specified subscription.", + "description": "Returns a list of Azure Bare Metal Instances in the specified subscription. The operations returns various properties of each Azure Bare Metal Instance.", + "x-ms-examples": { + "List all Azure Bare Metal Instances in a subscription": { + "$ref": "./examples/AzureBareMetalInstances_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances": { + "get": { + "tags": [ + "Bare Metal Instances" + ], + "operationId": "AzureBareMetalInstances_ListByResourceGroup", + "summary": "Gets a list of Azure Bare Metal Instances in the specified subscription and resource group.", + "description": "Gets a list of Azure Bare Metal Instances in the specified subscription and resource group. The operations returns various properties of each Azure Bare Metal Instance.", + "x-ms-examples": { + "List all Azure Bare Metal Instances in a resource group": { + "$ref": "./examples/AzureBareMetalInstances_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.BareMetalInfrastructure/operations": { + "get": { + "tags": [ + "Common" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "List all management operations supported by the AzureBareMetal RP": { + "$ref": "./examples/AzureBareMetalOperations_List.json" + } + }, + "summary": "Lists all of the available consumption REST API operations.", + "description": "Gets a list of AzureBareMetal management operations.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}": { + "get": { + "tags": [ + "Bare Metal Instances" + ], + "operationId": "AzureBareMetalInstances_Get", + "summary": "Gets an Azure Bare Metal Instance.", + "description": "Gets an Azure Bare Metal Instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Get an Azure Bare Metal Instance": { + "$ref": "./examples/AzureBareMetalInstances_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Bare Metal Instances" + ], + "operationId": "AzureBareMetalInstances_Update", + "summary": "Patches the Tags field of a Azure Bare Metal Instance.", + "description": "Patches the Tags field of a Azure Bare Metal Instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Update Tags field of an Azure Bare Metal Instance": { + "$ref": "./examples/AzureBareMetalInstances_PatchTags.json" + }, + "Delete Tags field of an Azure Bare Metal Instance": { + "$ref": "./examples/AzureBareMetalInstances_PatchTags_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + }, + { + "$ref": "#/parameters/TagsParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances": { + "get": { + "tags": [ + "Bare Metal Storage Instances" + ], + "operationId": "AzureBareMetalStorageInstances_ListBySubscription", + "summary": "Gets a list of Azure Bare Metal Storage instances in the specified subscription.", + "description": "Gets a list of AzureBareMetalStorage instances in the specified subscription. The operations returns various properties of each Azure Bare Metal Instance.", + "x-ms-examples": { + "List all AzureBareMetalStorage instances in a subscription": { + "$ref": "./examples/AzureBareMetalStorageInstances_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances": { + "get": { + "tags": [ + "Bare Metal Storage Instances" + ], + "operationId": "AzureBareMetalStorageInstances_ListByResourceGroup", + "summary": "Gets a list of Azure Bare Metal Storage instances in the specified subscription and resource group.", + "description": "Gets a list of AzureBareMetalStorage instances in the specified subscription and resource group. The operations returns various properties of each Azure Bare Metal Instance.", + "x-ms-examples": { + "List all AzureBareMetalStorage instances in a resource group": { + "$ref": "./examples/AzureBareMetalStorageInstances_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/{azureBareMetalStorageInstanceName}": { + "get": { + "tags": [ + "Bare Metal Storage Instances" + ], + "operationId": "AzureBareMetalStorageInstances_Get", + "summary": "Gets an Azure Bare Metal Storage instance.", + "description": "Gets an Azure Bare Metal Storage instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Get an AzureBareMetalStorage instance": { + "$ref": "./examples/AzureBareMetalStorageInstances_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalStorageInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Bare Metal Storage Instances" + ], + "summary": "Create an azure bare metal storage resource.", + "operationId": "AzureBareMetalStorageInstances_Create", + "x-ms-examples": { + "Put a new AzureBareMetalStorageInstance": { + "$ref": "./examples/AzureBareMetalStorageInstances_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalStorageInstanceNameParameter" + }, + { + "in": "body", + "name": "requestBodyParameters", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + }, + "description": "request body for put call" + } + ], + "responses": { + "200": { + "description": "Update ok. Successfully create a Azure Bare Metal Storage resource.", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + } + }, + "201": { + "description": "Created. The operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Bare Metal Storage Instances" + ], + "operationId": "AzureBareMetalStorageInstances_Update", + "summary": "Patches the Tags field of a Azure Bare Metal Storage instance.", + "description": "Patches the Tags field of a Azure Bare Metal Storage instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Update Tags field of an AzureBareMetalStorage instance": { + "$ref": "./examples/AzureBareMetalStorageInstances_PatchTags.json" + }, + "Delete Tags field of an AzureBareMetalStorage instance": { + "$ref": "./examples/AzureBareMetalStorageInstances_PatchTags_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalStorageInstanceNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalStorageInstanceBodyParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Bare Metal Storage Instances" + ], + "summary": "Delete an AzureBareMetalStorageInstance.", + "operationId": "AzureBareMetalStorageInstances_Delete", + "x-ms-examples": { + "Delete an AzureBareMetalStorageInstance": { + "$ref": "./examples/AzureBareMetalStorageInstances_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalStorageInstanceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The workspace for Grafana resource is deleted." + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AzureBareMetalInstancesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureBareMetalInstance" + }, + "description": "The list of Azure Bare Metal Instances." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of Azure Bare Metal Instances." + } + }, + "description": "The response from the List Azure Bare Metal Instances operation." + }, + "AzureBareMetalInstance": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBareMetalInstanceProperties", + "description": "AzureBareMetal instance properties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "AzureBareMetal instance info on Azure (ARM properties and AzureBareMetal properties)" + }, + "AzureBareMetalInstanceProperties": { + "type": "object", + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the Azure Bare Metal Instance." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the Azure Bare Metal Instance disks." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the Azure Bare Metal Instance." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network settings for the Azure Bare Metal Instance." + }, + "azureBareMetalInstanceId": { + "readOnly": true, + "type": "string", + "description": "Specifies the Azure Bare Metal Instance unique ID." + }, + "powerState": { + "readOnly": true, + "type": "string", + "enum": [ + "starting", + "started", + "stopping", + "stopped", + "restarting", + "unknown" + ], + "x-ms-enum": { + "name": "AzureBareMetalInstancePowerStateEnum", + "modelAsString": true + }, + "description": "Resource power state" + }, + "proximityPlacementGroup": { + "readOnly": true, + "type": "string", + "description": "Resource proximity placement group" + }, + "hwRevision": { + "readOnly": true, + "type": "string", + "description": "Hardware revision of an Azure Bare Metal Instance" + }, + "partnerNodeId": { + "type": "string", + "description": "ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ], + "x-ms-enum": { + "name": "AzureBareMetalProvisioningStatesEnum", + "modelAsString": true + }, + "description": "State of provisioning of the AzureBareMetalInstance" + } + }, + "description": "Describes the properties of an Azure Bare Metal Instance." + }, + "HardwareProfile": { + "type": "object", + "properties": { + "hardwareType": { + "readOnly": true, + "type": "string", + "enum": [ + "Cisco_UCS", + "HPE", + "SDFLEX" + ], + "x-ms-enum": { + "name": "AzureBareMetalHardwareTypeNamesEnum", + "modelAsString": true + }, + "description": "Name of the hardware type (vendor and/or their product name)" + }, + "azureBareMetalInstanceSize": { + "readOnly": true, + "type": "string", + "enum": [ + "S72m", + "S144m", + "S72", + "S144", + "S192", + "S192m", + "S192xm", + "S96", + "S112", + "S224", + "S224m", + "S224om", + "S224oo", + "S224oom", + "S224ooo", + "S384", + "S384m", + "S384xm", + "S384xxm", + "S448", + "S448m", + "S448om", + "S448oo", + "S448oom", + "S448ooo", + "S448se", + "S576m", + "S576xm", + "S672", + "S672m", + "S672om", + "S672oo", + "S672oom", + "S672ooo", + "S768", + "S768m", + "S768xm", + "S896", + "S896m", + "S896om", + "S896oo", + "S896oom", + "S896ooo", + "S960m" + ], + "x-ms-enum": { + "name": "azureBareMetalInstanceSizeNamesEnum", + "modelAsString": true + }, + "description": "Specifies the Azure Bare Metal Instance SKU." + } + }, + "description": "Specifies the hardware settings for the Azure Bare Metal Instance." + }, + "Disk": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes." + }, + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Specifies the disk information fo the Azure Bare Metal Instance" + }, + "StorageProfile": { + "type": "object", + "properties": { + "nfsIpAddress": { + "readOnly": true, + "type": "string", + "description": "IP Address to connect to storage." + }, + "osDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/Disk" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies information about the operating system disk used by bare metal instance." + } + }, + "description": "Specifies the storage settings for the Azure Bare Metal instance disks." + }, + "OSProfile": { + "type": "object", + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the Azure Bare Metal instance." + }, + "osType": { + "readOnly": true, + "type": "string", + "description": "This property allows you to specify the type of the OS." + }, + "version": { + "readOnly": true, + "type": "string", + "description": "Specifies version of operating system." + }, + "sshPublicKey": { + "type": "string", + "description": "Specifies the SSH public key used to access the operating system." + } + }, + "description": "Specifies the operating system settings for the Azure Bare Metal instance." + }, + "NetworkProfile": { + "type": "object", + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "x-ms-identifiers": [ + "ipAddress" + ], + "description": "Specifies the network interfaces for the Azure Bare Metal Instance." + }, + "circuitId": { + "readOnly": true, + "type": "string", + "description": "Specifies the circuit id for connecting to express route." + } + }, + "description": "Specifies the network settings for the Azure Bare Metal Instance disks." + }, + "NetworkInterface": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "description": "Specifies the IP address of the network interface." + } + }, + "description": "Specifies the network interfaces of a bare metal resource." + }, + "AzureBareMetalStorageInstancesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + }, + "description": "The list of AzureBareMetalStorage instances.", + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of AzureBareMetalStorage instances." + } + }, + "description": "The response from the Get AzureBareMetalStorageInstances operation." + }, + "AzureBareMetalStorageInstance": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBareMetalStorageInstanceProperties", + "description": "AzureBareMetalStorageInstance properties" + }, + "identity": { + "$ref": "#/definitions/AzureBareMetalStorageInstanceIdentity", + "description": "The identity of Azure Bare Metal Storage Instance, if configured." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "AzureBareMetalStorageInstance info on Azure (ARM properties and AzureBareMetalStorage properties)" + }, + "AzureBareMetalStorageInstanceProperties": { + "type": "object", + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": { + "type": "string", + "description": "Specifies the AzureBareMetaStorageInstance unique ID." + }, + "storageProperties": { + "$ref": "#/definitions/StorageProperties", + "description": "Specifies the storage properties for the AzureBareMetalStorage instance." + } + }, + "description": "Describes the properties of an AzureBareMetalStorageInstance." + }, + "AzureBareMetalStorageInstanceBody": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/AzureBareMetalStorageInstanceIdentity", + "description": "The identity of Azure Bare Metal Storage Instance, if configured." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags field of the AzureBareMetal/AzureBareMetaStorage instance." + } + }, + "description": "properties of body during PUT/PATCH for an AzureBareMetalStorageInstance." + }, + "AzureBareMetalStorageInstanceIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of Azure Bare Metal Storage Instance identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID associated with the Azure Bare Metal Storage Instance. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the Azure Bare Metal Storage Instance. The type 'SystemAssigned' refers to an implicitly created identity. The type 'None' will remove any identities from the Azure Bare Metal Storage Instance.", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": true + } + } + }, + "description": "Identity for Azure Bare Metal Storage Instance." + }, + "StorageProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Canceled", + "Migrating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "State of provisioning of the AzureBareMetalStorageInstance" + }, + "offeringType": { + "type": "string", + "description": "the offering type for which the resource is getting provisioned" + }, + "storageType": { + "type": "string", + "description": "the storage protocol for which the resource is getting provisioned" + }, + "generation": { + "type": "string", + "description": "the kind of storage instance" + }, + "hardwareType": { + "type": "string", + "description": "the hardware type of the storage instance" + }, + "workloadType": { + "type": "string", + "description": "the workload for which the resource is getting provisioned" + }, + "storageBillingProperties": { + "$ref": "#/definitions/StorageBillingProperties", + "description": "the billing related information for the resource" + } + }, + "description": "described the storage properties of the azure bare metal storage instance" + }, + "StorageBillingProperties": { + "type": "object", + "properties": { + "billingMode": { + "type": "string", + "description": "the billing mode for the storage instance" + }, + "azureBareMetalStorageInstanceSize": { + "type": "string", + "description": "the SKU type that is provisioned" + } + }, + "description": "Describes the billing related details of the AzureBareMetalStorageInstance." + }, + "Tags": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags field of the AzureBareMetal/AzureBareMetaStorage instance." + } + }, + "description": "Tags field of the AzureBareMetal/AzureBareMetaStorage instance." + }, + "ForceState": { + "type": "object", + "properties": { + "forceState": { + "type": "string", + "enum": [ + "active", + "inactive" + ], + "x-ms-enum": { + "name": "AzureBareMetalInstanceForcePowerState", + "modelAsString": true + }, + "description": "Whether to force restart by shutting all processes." + } + }, + "description": "The active state empowers the server with the ability to forcefully terminate and halt any existing processes that may be running on the server" + }, + "OperationStatus": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Unique Operation Status Identifier." + }, + "status": { + "type": "string", + "enum": [ + "Requesting", + "Executing", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncOperationStatus", + "modelAsString": true + }, + "description": "Status of the operation." + }, + "startTime": { + "type": "string", + "description": "Start Time when the operation was initially executed." + }, + "error": { + "description": "An error from the Azure Bare Metal Infrastructure service.", + "type": "object", + "properties": { + "code": { + "description": "Server-defined set of error codes.", + "type": "string" + }, + "message": { + "description": "Human-readable representation of the error.", + "type": "string" + } + } + } + }, + "description": "The OperationStatus object returns the state of an asynchronous operation." + } + }, + "parameters": { + "AzureBareMetalInstanceNameParameter": { + "name": "azureBareMetalInstanceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+$", + "description": "Name of the Azure Bare Metal Instance, also known as the ResourceName.", + "x-ms-parameter-location": "method" + }, + "AzureBareMetalStorageInstanceNameParameter": { + "name": "azureBareMetalStorageInstanceName", + "in": "path", + "required": true, + "type": "string", + "pattern": ".*", + "description": "Name of the Azure Bare Metal Storage Instance, also known as the ResourceName.", + "x-ms-parameter-location": "method" + }, + "ForcePowerManagementOperationParameter": { + "name": "forceParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ForceState" + }, + "description": "When set to 'active', this parameter empowers the server with the ability to forcefully terminate and halt any existing processes that may be running on the server", + "x-ms-parameter-location": "method" + }, + "TagsParameter": { + "name": "tagsParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Tags" + }, + "description": "Request body that only contains the new Tags field", + "x-ms-parameter-location": "method" + }, + "AzureBareMetalStorageInstanceBodyParameter": { + "name": "azureBareMetalStorageInstanceBodyParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstanceBody" + }, + "description": "Request body that only contains the Tags and Identity Field", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Get.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Get.json new file mode 100644 index 000000000000..a95405e4b223 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myAzureBareMetalInstance" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myAzureBareMetalInstance", + "location": "westus2", + "name": "myAzureBareMetalInstance", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalInstanceId": "23415635-4d7e-41dc-9598-8194f22c24e1", + "powerState": "restarting", + "hwRevision": "Rev 4.2", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "123.123.123.123" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuits/myCircuitId" + }, + "storageProfile": { + "nfsIpAddress": "123.123.119.123" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SLES 12 SP2", + "version": "12 SP2" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_ListByResourceGroup.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..461f3a050c34 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_ListByResourceGroup.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/azureBareMetalInstances/myAzureBareMetalInstance1", + "name": "myAzureBareMetalInstance1", + "type": "Microsoft.BareMetalInfrastructure/azureBareMetalInstances", + "location": "westus", + "tags": { + "key": "value" + }, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalInstanceId": "23415635-4d7e-41dc-9598-8194f22c24e1", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName1", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/azureBareMetalInstances/myABMInstance2", + "name": "myABMInstance2", + "type": "Microsoft.BareMetalInfrastructure/azureBareMetalInstances", + "location": "westus", + "tags": { + "key": "value" + }, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-21T08:01:22.0000000Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-13T08:01:22.1234567Z" + }, + "properties": { + "azureBareMetalInstanceId": "589bce49-9fe6-4dc8-82df-cf6ae25e0cb9", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "HPE", + "azureBareMetalInstanceSize": "S384" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.101" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.201" + }, + "osProfile": { + "computerName": "myComputerName2", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "partnerNodeId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/azureBareMetalInstances/myAzureBareMetalInstance1", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_ListBySubscription.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_ListBySubscription.json new file mode 100644 index 000000000000..c5284c6a2752 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_ListBySubscription.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/57d3422f-467a-448e-b798-ebf490849542/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myAzureBareMetalInstance1", + "location": "westus2", + "name": "myAzureBareMetalInstance1", + "tags": { + "key": "value" + }, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-21T08:01:22.0000000Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-13T08:01:22.1234567Z" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "properties": { + "azureBareMetalInstanceId": "23415635-4d7e-41dc-9598-8194f22c24e1", + "powerState": "restarting", + "hwRevision": "Rev 4.2", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "123.123.123.123" + } + ], + "circuitId": "/subscriptions/57d3422f-467a-448e-b798-ebf490849542/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuits/myCircuitId" + }, + "storageProfile": { + "nfsIpAddress": "123.123.119.123" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SLES 12 SP2", + "version": "12 SP2" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myAzureBareMetalInstance2", + "location": "westus2", + "name": "myAzureBareMetalInstance2", + "tags": { + "key": "value" + }, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-21T08:01:22.0000000Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-13T08:01:22.1234567Z" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "properties": { + "azureBareMetalInstanceId": "589bce49-9fe6-4dc8-82df-cf6ae25e0cb9", + "powerState": "restarting", + "hwRevision": "Rev 4.2", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "123.123.123.123" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuits/myCircuitId" + }, + "storageProfile": { + "nfsIpAddress": "123.123.119.123" + }, + "osProfile": { + "computerName": "myComputerName2", + "osType": "SLES 12 SP2", + "version": "12 SP2" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_PatchTags.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_PatchTags.json new file mode 100644 index 000000000000..2080f00d86ff --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_PatchTags.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance", + "tagsParameter": { + "tags": { + "testkey": "testvalue" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance", + "name": "myABMInstance", + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "location": "westus", + "tags": { + "testkey": "testvalue" + }, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalInstanceId": "23415635-4d7e-41dc-9598-8194f22c24e1", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "partnerNodeId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance2", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_PatchTags_Delete.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_PatchTags_Delete.json new file mode 100644 index 000000000000..c85d21b85a35 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_PatchTags_Delete.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance", + "tagsParameter": { + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance", + "name": "myABMInstance", + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalInstanceId": "23415635-4d7e-41dc-9598-8194f22c24e1", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "partnerNodeId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance2", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Restart.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Restart.json new file mode 100644 index 000000000000..9c7e7efa6d93 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Restart.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance", + "forceState": { + "state": "active" + } + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-0000000000001", + "status": "InProgress", + "startTime": "2023-08-01T21:17:24.9052926Z", + "error": { + "code": "", + "message": "" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/provide/Mircorosft.BareMetalInfrastructure/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000001?api-version=2023-11-01-preview", + "x-ms-correlation-request-id": "00000000-0000-0000-0000-000000000000", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Shutdown.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Shutdown.json new file mode 100644 index 000000000000..1ddbd0d8787d --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Shutdown.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000001", + "status": "InProgress", + "startTime": "2023-08-01T21:17:24.9052926Z", + "error": { + "code": "", + "message": "" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/provide/Mircorosft.BareMetalInfrastructure/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000001?api-version=2023-11-01-preview", + "x-ms-correlation-request-id": "00000000-0000-0000-0000-000000000000", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Start.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Start.json new file mode 100644 index 000000000000..1ddbd0d8787d --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalInstances_Start.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000001", + "status": "InProgress", + "startTime": "2023-08-01T21:17:24.9052926Z", + "error": { + "code": "", + "message": "" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/provide/Mircorosft.BareMetalInfrastructure/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000001?api-version=2023-11-01-preview", + "x-ms-correlation-request-id": "00000000-0000-0000-0000-000000000000", + "x-ms-request-id": "00000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalOperations_List.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalOperations_List.json new file mode 100644 index 000000000000..43137d72641e --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalOperations_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AzureBareMetalOp1", + "display": { + "provider": "AzureBareMetalOp1ProviderName", + "resource": "AzureBareMetalOp1ResourceName", + "operation": "AzureBareMetalOp1OperationName", + "description": "AzureBareMetalOp1Description" + }, + "isDataAction": false + }, + { + "name": "AzureBareMetalOp2", + "display": { + "provider": "AzureBareMetalOp2ProviderName", + "resource": "AzureBareMetalOp2ResourceName", + "operation": "AzureBareMetalOp2OperationName", + "description": "AzureBareMetalOp2Description" + }, + "isDataAction": true + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_Create.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_Create.json new file mode 100644 index 000000000000..1c16a1e75c14 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_Create.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalStorageInstanceName": "myAzureBareMetalStorageInstance", + "requestBodyParameters": { + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "tags": { + "key": "value" + }, + "location": "westus2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "", + "tenantId": "" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "", + "tenantId": "" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_Delete.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_Delete.json new file mode 100644 index 000000000000..63b7445e49e7 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalStorageInstanceName": "myAzureBareMetalStorageInstance" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_Get.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_Get.json new file mode 100644 index 000000000000..53735e4a4025 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalStorageInstanceName": "myAzureBareMetalStorageInstance" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "", + "tenantId": "" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_ListByResourceGroup.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..d567f50b28da --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_ListByResourceGroup.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance1", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance1", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "", + "tenantId": "" + } + }, + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance2", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance2", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-21T08:01:22.0000000Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-13T08:01:22.1234567Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24f7", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "NFS", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "Cogito", + "storageBillingProperties": { + "billingMode": "RI", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "", + "tenantId": "" + } + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_ListBySubscription.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_ListBySubscription.json new file mode 100644 index 000000000000..9c11dc1ed417 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_ListBySubscription.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance1", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance1", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "", + "tenantId": "" + } + }, + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance2", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance2", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-21T08:01:22.0000000Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-13T08:01:22.1234567Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24f7", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "NFS", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "Cogito", + "storageBillingProperties": { + "billingMode": "RI", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "", + "tenantId": "" + } + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_PatchTags.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_PatchTags.json new file mode 100644 index 000000000000..3592f9e0fcd2 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_PatchTags.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalStorageInstanceName": "myABMSInstance", + "azureBareMetalStorageInstanceBodyParameter": { + "identity": { + "type": "SystemAssigned" + }, + "tags": { + "testkey": "testvalue" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance", + "tags": { + "testkey": "testvalue" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "", + "tenantId": "" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_PatchTags_Delete.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_PatchTags_Delete.json new file mode 100644 index 000000000000..354b79dd17ea --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/examples/AzureBareMetalStorageInstances_PatchTags_Delete.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalStorageInstanceName": "myABMSInstance", + "azureBareMetalStorageInstanceBodyParameter": { + "identity": { + "type": "SystemAssigned" + }, + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance", + "tags": {}, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "", + "tenantId": "" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/readme.md b/specification/baremetalinfrastructure/resource-manager/readme.md index 4ef4130c7d61..3a00b4d62825 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.md @@ -26,18 +26,27 @@ These are the global settings for the BareMetalInfrastructure API. ``` yaml openapi-type: arm -tag: package-preview-2023-08 +tag: package-preview-2023-11 ``` +### Tag: package-preview-2023-11 + +These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-11' +input-file: + - Microsoft.BareMetalInfrastructure/preview/2023-11-01-preview/baremetalinfrastructure.json +``` ### Tag: package-preview-2023-08 These settings apply only when `--tag=package-preview-2023-08` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-08' +``` yaml $(tag) == 'package-preview-2023-08' input-file: - Microsoft.BareMetalInfrastructure/preview/2023-08-04-preview/baremetalinfrastructure.json ``` + ### Tag: package-2023-04-06 These settings apply only when `--tag=package-2023-04-06` is specified on the command line. diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/BatchManagement.json new file mode 100644 index 000000000000..7a4d8888f6e5 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/BatchManagement.json @@ -0,0 +1,6540 @@ +{ + "swagger": "2.0", + "info": { + "title": "BatchManagementClient", + "description": "The Batch Management Client.", + "version": "2023-11-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Microsoft Entra OAuth 2.0 auth code flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}": { + "put": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Create", + "x-ms-examples": { + "BatchAccountCreate_Default": { + "$ref": "./examples/BatchAccountCreate_Default.json" + }, + "BatchAccountCreate_BYOS": { + "$ref": "./examples/BatchAccountCreate_BYOS.json" + }, + "PrivateBatchAccountCreate": { + "$ref": "./examples/PrivateBatchAccountCreate.json" + }, + "BatchAccountCreate_SystemAssignedIdentity": { + "$ref": "./examples/BatchAccountCreate_SystemAssignedIdentity.json" + }, + "BatchAccountCreate_UserAssignedIdentity": { + "$ref": "./examples/BatchAccountCreate_UserAssignedIdentity.json" + } + }, + "description": "Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z0-9]+$", + "minLength": 3, + "maxLength": 24, + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountCreateParameters" + }, + "description": "Additional parameters for account creation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account entity.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Update", + "x-ms-examples": { + "BatchAccountUpdate": { + "$ref": "./examples/BatchAccountUpdate.json" + } + }, + "description": "Updates the properties of an existing Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountUpdateParameters" + }, + "description": "Additional parameters for account update." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account entity.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Delete", + "x-ms-examples": { + "BatchAccountDelete": { + "$ref": "./examples/BatchAccountDelete.json" + } + }, + "description": "Deletes the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "NoContent -- account does not exist in the subscription." + }, + "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" + } + }, + "get": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Get", + "x-ms-examples": { + "BatchAccountGet": { + "$ref": "./examples/BatchAccountGet.json" + }, + "PrivateBatchAccountGet": { + "$ref": "./examples/PrivateBatchAccountGet.json" + } + }, + "description": "Gets information about the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account entity.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts": { + "get": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_List", + "x-ms-examples": { + "BatchAccountList": { + "$ref": "./examples/BatchAccountList.json" + } + }, + "description": "Gets information about the Batch accounts associated with the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of Batch account entities associated with the subscription.", + "schema": { + "$ref": "#/definitions/BatchAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts": { + "get": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_ListByResourceGroup", + "x-ms-examples": { + "BatchAccountListByResourceGroup": { + "$ref": "./examples/BatchAccountListByResourceGroup.json" + } + }, + "description": "Gets information about the Batch accounts associated with the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of Batch account entities associated with the resource group.", + "schema": { + "$ref": "#/definitions/BatchAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys": { + "post": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_SynchronizeAutoStorageKeys", + "x-ms-examples": { + "BatchAccountSynchronizeAutoStorageKeys": { + "$ref": "./examples/BatchAccountSynchronizeAutoStorageKeys.json" + } + }, + "description": "Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The operation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys": { + "post": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_RegenerateKey", + "x-ms-examples": { + "BatchAccountRegenerateKey": { + "$ref": "./examples/BatchAccountRegenerateKey.json" + } + }, + "summary": "Regenerates the specified account key for the Batch account.", + "description": "This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountRegenerateKeyParameters" + }, + "description": "The type of key to regenerate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account keys.", + "schema": { + "$ref": "#/definitions/BatchAccountKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys": { + "post": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_GetKeys", + "x-ms-examples": { + "BatchAccountGetKeys": { + "$ref": "./examples/BatchAccountGetKeys.json" + } + }, + "summary": "Gets the account keys for the specified Batch account.", + "description": "This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the keys of the Batch account.", + "schema": { + "$ref": "#/definitions/BatchAccountKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}/activate": { + "post": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Activate", + "x-ms-examples": { + "ApplicationPackageActivate": { + "$ref": "./examples/ApplicationPackageActivate.json" + } + }, + "description": "Activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActivateApplicationPackageParameters" + }, + "description": "The parameters for the request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application package entity.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}": { + "put": { + "tags": [ + "Application" + ], + "operationId": "Application_Create", + "x-ms-examples": { + "ApplicationCreate": { + "$ref": "./examples/ApplicationCreate.json" + } + }, + "description": "Adds an application to the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "The parameters for the request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application entity.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Application_Delete", + "x-ms-examples": { + "ApplicationDelete": { + "$ref": "./examples/ApplicationDelete.json" + } + }, + "description": "Deletes an application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "Application" + ], + "operationId": "Application_Get", + "x-ms-examples": { + "ApplicationGet": { + "$ref": "./examples/ApplicationGet.json" + } + }, + "description": "Gets information about the specified application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application entity.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Application_Update", + "x-ms-examples": { + "ApplicationUpdate": { + "$ref": "./examples/ApplicationUpdate.json" + } + }, + "description": "Updates settings for the specified application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "The parameters for the request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application entity.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}": { + "put": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Create", + "x-ms-examples": { + "ApplicationPackageCreate": { + "$ref": "./examples/ApplicationPackageCreate.json" + } + }, + "description": "Creates an application package record. The record contains a storageUrl where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used. If the auto storage account was configured to use storage keys, the URL returned will contain a SAS.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPackage" + }, + "description": "The parameters for the request." + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application package entity.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Delete", + "x-ms-examples": { + "ApplicationPackageDelete": { + "$ref": "./examples/ApplicationPackageDelete.json" + } + }, + "description": "Deletes an application package record and its associated binary file.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Get", + "x-ms-examples": { + "ApplicationPackageGet": { + "$ref": "./examples/ApplicationPackageGet.json" + } + }, + "description": "Gets information about the specified application package.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application package entity.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Application_List", + "x-ms-examples": { + "ApplicationList": { + "$ref": "./examples/ApplicationList.json" + } + }, + "description": "Lists all of the applications in the specified account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of the application entities associated with the specified account.", + "schema": { + "$ref": "#/definitions/ListApplicationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions": { + "get": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_List", + "x-ms-examples": { + "ApplicationPackageList": { + "$ref": "./examples/ApplicationPackageList.json" + } + }, + "description": "Lists all of the application packages in the specified application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of the application package entities associated with the specified application.", + "schema": { + "$ref": "#/definitions/ListApplicationPackagesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas": { + "get": { + "tags": [ + "Location" + ], + "operationId": "Location_GetQuotas", + "x-ms-examples": { + "LocationGetQuotas": { + "$ref": "./examples/LocationGetQuotas.json" + } + }, + "description": "Gets the Batch service quotas for the specified subscription at the given location.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The region for which to retrieve Batch service quotas." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch service quotas for the subscription in the specified location.", + "schema": { + "$ref": "#/definitions/BatchLocationQuota" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/virtualMachineSkus": { + "get": { + "tags": [ + "Location" + ], + "operationId": "Location_ListSupportedVirtualMachineSkus", + "x-ms-examples": { + "LocationListVirtualMachineSkus": { + "$ref": "./examples/LocationListVirtualMachineSkus.json" + } + }, + "description": "Gets the list of Batch supported Virtual Machine VM sizes available at the given location.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The region for which to retrieve Batch service supported SKUs." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are \"familyName\"." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch service supported virtual machine vm sizes for the subscription in the specified location.", + "schema": { + "$ref": "#/definitions/SupportedSkusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/cloudServiceSkus": { + "get": { + "tags": [ + "Location" + ], + "operationId": "Location_ListSupportedCloudServiceSkus", + "x-ms-examples": { + "LocationListCloudServiceSkus": { + "$ref": "./examples/LocationListCloudServiceSkus.json" + } + }, + "description": "Gets the list of Batch supported Cloud Service VM sizes available at the given location.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The region for which to retrieve Batch service supported SKUs." + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are \"familyName\"." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch service supported Cloud Service VM sizes for the subscription in the specified location.", + "schema": { + "$ref": "#/definitions/SupportedSkusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Batch/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "Lists available operations for the Microsoft.Batch provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability": { + "post": { + "operationId": "Location_CheckNameAvailability", + "description": "Checks whether the Batch account name is available in the specified region.", + "x-ms-examples": { + "LocationCheckNameAvailability_Available": { + "$ref": "./examples/LocationCheckNameAvailability_Available.json" + }, + "LocationCheckNameAvailability_AlreadyExists": { + "$ref": "./examples/LocationCheckNameAvailability_AlreadyExists.json" + } + }, + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The desired region for the name check." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + }, + "description": "Properties needed to check the availability of a name." + } + ], + "responses": { + "200": { + "description": "Success. Returns details about whether a Batch account name is available.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates": { + "get": { + "tags": [ + "Certificate" + ], + "deprecated": true, + "operationId": "Certificate_ListByBatchAccount", + "summary": "Lists all of the certificates in the specified account.", + "description": "Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", + "x-ms-examples": { + "ListCertificates": { + "$ref": "./examples/CertificateList.json" + }, + "ListCertificates - Filter and Select": { + "$ref": "./examples/CertificateListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are \"properties/provisioningState\", \"properties/provisioningStateTransitionTime\", \"name\"." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of certificates associated with the account.", + "schema": { + "$ref": "#/definitions/ListCertificatesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}": { + "put": { + "tags": [ + "Certificate" + ], + "deprecated": true, + "operationId": "Certificate_Create", + "summary": "Creates a new certificate inside the specified account.", + "description": "Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", + "x-ms-examples": { + "CreateCertificate - Minimal Pfx": { + "$ref": "./examples/CertificateCreate_Minimal.json" + }, + "CreateCertificate - Minimal Cer": { + "$ref": "./examples/CertificateCreate_MinimalCer.json" + }, + "CreateCertificate - Full": { + "$ref": "./examples/CertificateCreate_Full.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateCreateOrUpdateParameters" + }, + "description": "Additional parameters for certificate creation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the certificate to update. A value of \"*\" can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Certificate" + ], + "deprecated": true, + "operationId": "Certificate_Update", + "summary": "Updates the properties of an existing certificate.", + "description": "Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", + "x-ms-examples": { + "UpdateCertificate": { + "$ref": "./examples/CertificateUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateCreateOrUpdateParameters" + }, + "description": "Certificate entity to update." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the certificate to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Certificate" + ], + "deprecated": true, + "operationId": "Certificate_Delete", + "summary": "Deletes the specified certificate.", + "description": "Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", + "x-ms-examples": { + "CertificateDelete": { + "$ref": "./examples/CertificateDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "The operation was successful." + }, + "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" + } + }, + "get": { + "tags": [ + "Certificate" + ], + "deprecated": true, + "operationId": "Certificate_Get", + "summary": "Gets information about the specified certificate.", + "description": "Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", + "x-ms-examples": { + "Get Certificate": { + "$ref": "./examples/CertificateGet.json" + }, + "Get Certificate with Deletion Error": { + "$ref": "./examples/CertificateGetWithDeletionError.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}/cancelDelete": { + "post": { + "tags": [ + "Certificate" + ], + "deprecated": true, + "operationId": "Certificate_CancelDeletion", + "summary": "Cancels a failed deletion of a certificate from the specified account.", + "description": "If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.\n\nWarning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", + "x-ms-examples": { + "CertificateCancelDeletion": { + "$ref": "./examples/CertificateCancelDeletion.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors": { + "get": { + "operationId": "BatchAccount_ListDetectors", + "description": "Gets information about the detectors available for a given Batch account.", + "x-ms-examples": { + "ListDetectors": { + "$ref": "./examples/DetectorList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of detectors associated with a Batch account.", + "schema": { + "$ref": "#/definitions/DetectorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors/{detectorId}": { + "get": { + "operationId": "BatchAccount_GetDetector", + "description": "Gets information about the given detector for a given Batch account.", + "x-ms-examples": { + "GetDetector": { + "$ref": "./examples/DetectorGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/DetectorIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains information about the given detector associated with a Batch account.", + "schema": { + "$ref": "#/definitions/DetectorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResource" + ], + "operationId": "PrivateLinkResource_ListByBatchAccount", + "description": "Lists all of the private link resources in the specified account.", + "x-ms-examples": { + "ListPrivateLinkResource": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of private link resources associated with the account.", + "schema": { + "$ref": "#/definitions/ListPrivateLinkResourcesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "tags": [ + "PrivateLinkResource" + ], + "operationId": "PrivateLinkResource_Get", + "description": "Gets information about the specified private link resource.", + "x-ms-examples": { + "GetPrivateLinkResource": { + "$ref": "./examples/PrivateLinkResourceGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PrivateLinkResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the private link resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "operationId": "PrivateEndpointConnection_ListByBatchAccount", + "description": "Lists all of the private endpoint connections in the specified account.", + "x-ms-examples": { + "ListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of private link resources associated with the account.", + "schema": { + "$ref": "#/definitions/ListPrivateEndpointConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "operationId": "PrivateEndpointConnection_Get", + "description": "Gets information about the specified private endpoint connection.", + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "PrivateEndpointConnection" + ], + "operationId": "PrivateEndpointConnection_Update", + "description": "Updates the properties of an existing private endpoint connection.", + "x-ms-examples": { + "UpdatePrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnectionUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the PrivateEndpointConnection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "The operation was accepted and will be performed in the background.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnection" + ], + "operationId": "PrivateEndpointConnection_Delete", + "x-ms-examples": { + "PrivateEndpointConnectionDelete": { + "$ref": "./examples/PrivateEndpointConnectionDelete.json" + } + }, + "description": "Deletes the specified private endpoint connection.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "The operation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools": { + "get": { + "tags": [ + "Pool" + ], + "operationId": "Pool_ListByBatchAccount", + "description": "Lists all of the pools in the specified account.", + "x-ms-examples": { + "ListPool": { + "$ref": "./examples/PoolList.json" + }, + "ListPoolWithFilter": { + "$ref": "./examples/PoolListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are:\n\n name\n properties/allocationState\n properties/allocationStateTransitionTime\n properties/creationTime\n properties/provisioningState\n properties/provisioningStateTransitionTime\n properties/lastModified\n properties/vmSize\n properties/interNodeCommunication\n properties/scaleSettings/autoScale\n properties/scaleSettings/fixedScale" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of certificates associated with the account.", + "schema": { + "$ref": "#/definitions/ListPoolsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}": { + "put": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Create", + "description": "Creates a new pool inside the specified account.", + "x-ms-examples": { + "CreatePool - Minimal CloudServiceConfiguration": { + "$ref": "./examples/PoolCreate_MinimalCloudServiceConfiguration.json" + }, + "CreatePool - Minimal VirtualMachineConfiguration": { + "$ref": "./examples/PoolCreate_MinimalVirtualMachineConfiguration.json" + }, + "CreatePool - Full CloudServiceConfiguration": { + "$ref": "./examples/PoolCreate_CloudServiceConfiguration.json" + }, + "CreatePool - ResourceTags": { + "$ref": "./examples/PoolCreate_ResourceTags.json" + }, + "CreatePool - Custom Image": { + "$ref": "./examples/PoolCreate_SharedImageGallery.json" + }, + "CreatePool - Public IPs": { + "$ref": "./examples/PoolCreate_PublicIPs.json" + }, + "CreatePool - Full VirtualMachineConfiguration": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration.json" + }, + "CreatePool - No public IP": { + "$ref": "./examples/PoolCreate_NoPublicIPAddresses.json" + }, + "CreatePool - UserAssignedIdentities": { + "$ref": "./examples/PoolCreate_UserAssignedIdentities.json" + }, + "CreatePool - VirtualMachineConfiguration Extensions": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration_Extensions.json" + }, + "CreatePool - accelerated networking": { + "$ref": "./examples/PoolCreate_AcceleratedNetworking.json" + }, + "CreatePool - SecurityProfile": { + "$ref": "./examples/PoolCreate_SecurityProfile.json" + }, + "CreatePool - VirtualMachineConfiguration ServiceArtifactReference": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json" + }, + "CreatePool - VirtualMachineConfiguration OSDisk": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + }, + "description": "Additional parameters for pool creation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the pool to update. A value of \"*\" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Update", + "description": "Updates the properties of an existing pool.", + "x-ms-examples": { + "UpdatePool - Resize Pool": { + "$ref": "./examples/PoolUpdate_ResizePool.json" + }, + "UpdatePool - Enable Autoscale": { + "$ref": "./examples/PoolUpdate_EnableAutoScale.json" + }, + "UpdatePool - Remove Start Task": { + "$ref": "./examples/PoolUpdate_RemoveStartTask.json" + }, + "UpdatePool - Other Properties": { + "$ref": "./examples/PoolUpdate_OtherProperties.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + }, + "description": "Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the pool to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Delete", + "description": "Deletes the specified pool.", + "x-ms-examples": { + "DeletePool": { + "$ref": "./examples/PoolDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "The operation was successful." + }, + "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" + } + }, + "get": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Get", + "description": "Gets information about the specified pool.", + "x-ms-examples": { + "GetPool": { + "$ref": "./examples/PoolGet.json" + }, + "GetPool - VirtualMachineConfiguration Extensions": { + "$ref": "./examples/PoolGet_VirtualMachineConfiguration_Extensions.json" + }, + "GetPool - AcceleratedNetworking": { + "$ref": "./examples/PoolGet_AcceleratedNetworking.json" + }, + "GetPool - SecurityProfile": { + "$ref": "./examples/PoolGet_SecurityProfile.json" + }, + "GetPool - VirtualMachineConfiguration ServiceArtifactReference": { + "$ref": "./examples/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json" + }, + "GetPool - VirtualMachineConfiguration OSDisk": { + "$ref": "./examples/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/disableAutoScale": { + "post": { + "tags": [ + "Pool" + ], + "operationId": "Pool_DisableAutoScale", + "description": "Disables automatic scaling for a pool.", + "x-ms-examples": { + "Disable AutoScale": { + "$ref": "./examples/PoolDisableAutoScale.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/stopResize": { + "post": { + "tags": [ + "Pool" + ], + "operationId": "Pool_StopResize", + "summary": "Stops an ongoing resize operation on the pool.", + "description": "This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.", + "x-ms-examples": { + "StopPoolResize": { + "$ref": "./examples/PoolStopResize.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_ListOutboundNetworkDependenciesEndpoints", + "description": "Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network.", + "x-ms-examples": { + "ListOutboundNetworkDependencies": { + "$ref": "./examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of outbound network dependencies.", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AutoStorageBaseProperties": { + "type": "object", + "properties": { + "storageAccountId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + }, + "description": "The resource ID of the storage account to be used for auto-storage account." + }, + "authenticationMode": { + "type": "string", + "description": "The authentication mode which the Batch service will use to manage the auto-storage account.", + "default": "StorageKeys", + "enum": [ + "StorageKeys", + "BatchAccountManagedIdentity" + ], + "x-ms-enum": { + "name": "AutoStorageAuthenticationMode", + "modelAsString": false, + "values": [ + { + "value": "StorageKeys", + "description": "The Batch service will authenticate requests to auto-storage using storage account keys." + }, + { + "value": "BatchAccountManagedIdentity", + "description": "The Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account." + } + ] + } + }, + "nodeIdentityReference": { + "title": "The reference to the user assigned identity which compute nodes will use to access auto-storage.", + "description": "The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage.", + "$ref": "#/definitions/ComputeNodeIdentityReference" + } + }, + "required": [ + "storageAccountId" + ], + "description": "The properties related to the auto-storage account." + }, + "BatchAccountUpdateProperties": { + "type": "object", + "properties": { + "autoStorage": { + "$ref": "#/definitions/AutoStorageBaseProperties", + "description": "The properties related to the auto-storage account." + }, + "encryption": { + "title": "The encryption configuration for the Batch account.", + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.", + "$ref": "#/definitions/EncryptionProperties" + }, + "allowedAuthenticationModes": { + "x-nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/AuthenticationMode" + }, + "description": "List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane." + }, + "publicNetworkAccess": { + "title": "The network access type for accessing Azure Batch account.", + "description": "If not specified, the default value is 'enabled'.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "networkProfile": { + "title": "Network profile for Batch account, which contains network rule settings for each endpoint.", + "description": "The network profile only takes effect when publicNetworkAccess is enabled.", + "$ref": "#/definitions/NetworkProfile" + } + }, + "description": "The properties of a Batch account." + }, + "BatchAccountCreateProperties": { + "type": "object", + "properties": { + "autoStorage": { + "$ref": "#/definitions/AutoStorageBaseProperties", + "description": "The properties related to the auto-storage account." + }, + "poolAllocationMode": { + "title": "The allocation mode to use for creating pools in the Batch account.", + "description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.", + "$ref": "#/definitions/PoolAllocationMode" + }, + "keyVaultReference": { + "$ref": "#/definitions/KeyVaultReference", + "description": "A reference to the Azure key vault associated with the Batch account." + }, + "publicNetworkAccess": { + "title": "The network access type for accessing Azure Batch account.", + "description": "If not specified, the default value is 'enabled'.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "networkProfile": { + "title": "Network profile for Batch account, which contains network rule settings for each endpoint.", + "description": "The network profile only takes effect when publicNetworkAccess is enabled.", + "$ref": "#/definitions/NetworkProfile" + }, + "encryption": { + "title": "The encryption configuration for the Batch account.", + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.", + "$ref": "#/definitions/EncryptionProperties" + }, + "allowedAuthenticationModes": { + "x-nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/AuthenticationMode" + }, + "description": "List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane." + } + }, + "description": "The properties of a Batch account." + }, + "AuthenticationMode": { + "type": "string", + "description": "The authentication mode for the Batch account.", + "enum": [ + "SharedKey", + "AAD", + "TaskAuthenticationToken" + ], + "x-ms-enum": { + "name": "AuthenticationMode", + "modelAsString": false, + "values": [ + { + "value": "SharedKey", + "description": "The authentication mode using shared keys." + }, + { + "value": "AAD", + "description": "The authentication mode using Microsoft Entra ID." + }, + { + "value": "TaskAuthenticationToken", + "description": "The authentication mode using task authentication tokens." + } + ] + } + }, + "BatchAccountCreateParameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The region in which to create the account." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The user-specified tags associated with the account." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BatchAccountCreateProperties", + "description": "The properties of the Batch account." + }, + "identity": { + "$ref": "#/definitions/BatchAccountIdentity", + "description": "The identity of the Batch account." + } + }, + "required": [ + "location" + ], + "description": "Parameters supplied to the Create operation." + }, + "KeyVaultReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "The resource ID of the Azure key vault associated with the Batch account." + }, + "url": { + "type": "string", + "description": "The URL of the Azure key vault associated with the Batch account." + } + }, + "required": [ + "id", + "url" + ], + "description": "Identifies the Azure key vault associated with a Batch account." + }, + "AutoStorageProperties": { + "type": "object", + "properties": { + "lastKeySync": { + "type": "string", + "format": "date-time", + "description": "The UTC time at which storage keys were last synchronized with the Batch account." + } + }, + "required": [ + "lastKeySync" + ], + "allOf": [ + { + "$ref": "#/definitions/AutoStorageBaseProperties" + } + ], + "description": "Contains information about the auto-storage account associated with a Batch account." + }, + "VirtualMachineFamilyCoreQuota": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "x-nullable": false, + "type": "string", + "description": "The Virtual Machine family name." + }, + "coreQuota": { + "readOnly": true, + "x-nullable": false, + "type": "integer", + "format": "int32", + "description": "The core quota for the VM family for the Batch account." + } + }, + "description": "A VM Family and its associated core quota for the Batch account." + }, + "BatchAccountIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the Batch account. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the Batch account. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the Batch account.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Batch account has a system assigned identity with it." + }, + { + "value": "UserAssigned", + "description": "Batch account has user assigned identities with it." + }, + { + "value": "None", + "description": "Batch account has no identity associated with it. Setting `None` in update account will remove existing identities." + } + ] + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the Batch account.", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentities" + } + } + }, + "description": "The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when `ManagedIdentity` is selected as the auto-storage authentication mode.", + "required": [ + "type" + ] + }, + "BatchAccountProperties": { + "type": "object", + "properties": { + "accountEndpoint": { + "type": "string", + "readOnly": true, + "description": "The account endpoint used to interact with the Batch service." + }, + "nodeManagementEndpoint": { + "type": "string", + "readOnly": true, + "description": "The endpoint used by compute node to connect to the Batch node management service." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "description": "The provisioned state of the resource", + "enum": [ + "Invalid", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Invalid", + "description": "The account is in an invalid state." + }, + { + "value": "Creating", + "description": "The account is being created." + }, + { + "value": "Deleting", + "description": "The account is being deleted." + }, + { + "value": "Succeeded", + "description": "The account has been created and is ready for use." + }, + { + "value": "Failed", + "description": "The last operation for the account is failed." + }, + { + "value": "Cancelled", + "description": "The last operation for the account is cancelled." + } + ] + } + }, + "poolAllocationMode": { + "readOnly": true, + "x-nullable": false, + "title": "The allocation mode to use for creating pools in the Batch account.", + "$ref": "#/definitions/PoolAllocationMode" + }, + "keyVaultReference": { + "title": "A reference to the Azure key vault associated with the Batch account.", + "readOnly": true, + "$ref": "#/definitions/KeyVaultReference" + }, + "publicNetworkAccess": { + "x-nullable": true, + "title": "The network interface type for accessing Azure Batch service and Batch account operations.", + "description": "If not specified, the default value is 'enabled'.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "networkProfile": { + "x-nullable": true, + "title": "Network profile for Batch account, which contains network rule settings for each endpoint.", + "description": "The network profile only takes effect when publicNetworkAccess is enabled.", + "$ref": "#/definitions/NetworkProfile" + }, + "privateEndpointConnections": { + "readOnly": true, + "x-nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connections associated with the Batch account" + }, + "autoStorage": { + "title": "The properties and status of any auto-storage account associated with the Batch account.", + "readOnly": true, + "$ref": "#/definitions/AutoStorageProperties" + }, + "encryption": { + "title": "The encryption configuration for the Batch account.", + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.", + "readOnly": true, + "$ref": "#/definitions/EncryptionProperties" + }, + "dedicatedCoreQuota": { + "readOnly": true, + "x-nullable": true, + "type": "integer", + "format": "int32", + "title": "The dedicated core quota for the Batch account.", + "description": "For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned." + }, + "lowPriorityCoreQuota": { + "readOnly": true, + "x-nullable": true, + "type": "integer", + "format": "int32", + "title": "The Spot/low-priority core quota for the Batch account.", + "description": "For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned." + }, + "dedicatedCoreQuotaPerVMFamily": { + "readOnly": true, + "x-nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineFamilyCoreQuota" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned." + }, + "dedicatedCoreQuotaPerVMFamilyEnforced": { + "readOnly": true, + "x-nullable": false, + "type": "boolean", + "title": "A value indicating whether core quotas per Virtual Machine family are enforced for this account", + "description": "If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family." + }, + "poolQuota": { + "readOnly": true, + "x-nullable": false, + "type": "integer", + "format": "int32", + "title": "The pool quota for the Batch account." + }, + "activeJobAndJobScheduleQuota": { + "readOnly": true, + "x-nullable": false, + "type": "integer", + "format": "int32", + "title": "The active job and job schedule quota for the Batch account." + }, + "allowedAuthenticationModes": { + "readOnly": true, + "x-nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/AuthenticationMode" + }, + "description": "List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane." + } + }, + "description": "Account specific properties." + }, + "BatchAccount": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BatchAccountProperties", + "description": "The properties associated with the account." + }, + "identity": { + "$ref": "#/definitions/BatchAccountIdentity", + "description": "The identity of the Batch account." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Contains information about an Azure Batch account." + }, + "BatchAccountUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The user-specified tags associated with the account." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BatchAccountUpdateProperties", + "description": "The properties of the account." + }, + "identity": { + "$ref": "#/definitions/BatchAccountIdentity", + "description": "The identity of the Batch account." + } + }, + "description": "Parameters for updating an Azure Batch account." + }, + "BatchAccountListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BatchAccount" + }, + "x-ms-identifiers": [ + "/properties/accountEndpoint" + ], + "description": "The collection of Batch accounts returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "EncryptionProperties": { + "type": "object", + "properties": { + "keySource": { + "type": "string", + "description": "Type of the key source.", + "enum": [ + "Microsoft.Batch", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": false, + "values": [ + { + "value": "Microsoft.Batch", + "description": "Batch creates and manages the encryption keys used to protect the account data." + }, + { + "value": "Microsoft.KeyVault", + "description": "The encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to `SystemAssigned` and a valid Key Identifier must also be supplied under the keyVaultProperties." + } + ] + } + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Additional details when using Microsoft.KeyVault" + } + }, + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead." + }, + "KeyVaultProperties": { + "type": "object", + "properties": { + "keyIdentifier": { + "type": "string", + "description": "Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:\n\n The Batch Account has a System Assigned identity\n The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions\n The KeyVault has soft-delete and purge protection enabled" + } + }, + "description": "KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault." + }, + "BatchAccountRegenerateKeyParameters": { + "type": "object", + "properties": { + "keyName": { + "type": "string", + "description": "The type of account key to regenerate.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "AccountKeyType", + "modelAsString": false, + "values": [ + { + "value": "Primary", + "description": "The primary account key." + }, + { + "value": "Secondary", + "description": "The secondary account key." + } + ] + } + } + }, + "required": [ + "keyName" + ], + "description": "Parameters supplied to the RegenerateKey operation." + }, + "BatchAccountKeys": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "readOnly": true, + "description": "The Batch account name." + }, + "primary": { + "type": "string", + "readOnly": true, + "description": "The primary key associated with the account." + }, + "secondary": { + "type": "string", + "readOnly": true, + "description": "The secondary key associated with the account." + } + }, + "description": "A set of Azure Batch account keys." + }, + "ActivateApplicationPackageParameters": { + "type": "object", + "properties": { + "format": { + "type": "string", + "description": "The format of the application package binary file." + } + }, + "required": [ + "format" + ], + "description": "Parameters for an activating an application package." + }, + "Application": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties", + "description": "The properties associated with the Application." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about an application in a Batch account." + }, + "ApplicationProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The display name for the application." + }, + "allowUpdates": { + "type": "boolean", + "description": "A value indicating whether packages within the application may be overwritten using the same version string." + }, + "defaultVersion": { + "type": "string", + "description": "The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package." + } + }, + "description": "The properties associated with the Application." + }, + "ApplicationPackage": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationPackageProperties", + "description": "The properties associated with the Application Package." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "An application package which represents a particular version of an application." + }, + "ApplicationPackageProperties": { + "type": "object", + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The current state of the application package.", + "enum": [ + "Pending", + "Active" + ], + "x-ms-enum": { + "name": "PackageState", + "modelAsString": false, + "values": [ + { + "value": "Pending", + "description": "The application package has been created but has not yet been activated." + }, + { + "value": "Active", + "description": "The application package is ready for use." + } + ] + } + }, + "format": { + "type": "string", + "readOnly": true, + "description": "The format of the application package, if the package is active." + }, + "storageUrl": { + "type": "string", + "readOnly": true, + "description": "The URL for the application package in Azure Storage." + }, + "storageUrlExpiry": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The UTC time at which the Azure Storage URL will expire." + }, + "lastActivationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time at which the package was last activated, if the package is active." + } + }, + "description": "Properties of an application package" + }, + "ListApplicationsResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Application" + }, + "description": "The list of applications." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The result of performing list applications." + }, + "ListApplicationPackagesResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackage" + }, + "description": "The list of application packages." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The result of performing list application packages." + }, + "BatchLocationQuota": { + "type": "object", + "properties": { + "accountQuota": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The number of Batch accounts that may be created under the subscription in the specified region." + } + }, + "description": "Quotas associated with a Batch region for a particular subscription." + }, + "Resource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags of the resource." + } + }, + "description": "A definition of an Azure resource.", + "x-ms-azure-resource": true + }, + "ProxyResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The ETag of the resource, used for concurrency statements." + } + }, + "description": "A definition of an Azure resource.", + "x-ms-azure-resource": true + }, + "PublicNetworkAccessType": { + "type": "string", + "description": "The network access type for operating on the resources in the Batch account.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": false, + "values": [ + { + "value": "Enabled", + "description": "Enables connectivity to Azure Batch through public DNS." + }, + { + "value": "Disabled", + "description": "Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource." + } + ] + } + }, + "NetworkProfile": { + "type": "object", + "properties": { + "accountAccess": { + "$ref": "#/definitions/EndpointAccessProfile", + "description": "Network access profile for batchAccount endpoint (Batch account data plane API)." + }, + "nodeManagementAccess": { + "$ref": "#/definitions/EndpointAccessProfile", + "description": "Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools)." + } + }, + "description": "Network profile for Batch account, which contains network rule settings for each endpoint." + }, + "EndpointAccessProfile": { + "type": "object", + "properties": { + "defaultAction": { + "type": "string", + "title": "The default action when there is no IPRule matched.", + "description": "Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "EndpointAccessDefaultAction", + "modelAsString": false, + "values": [ + { + "value": "Allow", + "description": "Allow client access." + }, + { + "value": "Deny", + "description": "Deny client access." + } + ] + } + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/IPRule" + }, + "x-ms-identifiers": [ + "action" + ], + "description": "Array of IP ranges to filter client IP address." + } + }, + "description": "Network access profile for Batch endpoint.", + "required": [ + "defaultAction" + ] + }, + "IPRule": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action when client IP address is matched.", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "IPRuleAction", + "modelAsString": false, + "values": [ + { + "value": "Allow", + "description": "Allow access for the matched client IP address." + } + ] + } + }, + "value": { + "type": "string", + "title": "The IP address or IP address range to filter", + "description": "IPv4 address, or IPv4 address range in CIDR format." + } + }, + "description": "Rule to filter client IP address.", + "required": [ + "action", + "value" + ] + }, + "PoolAllocationMode": { + "type": "string", + "description": "The allocation mode for creating pools in the Batch account.", + "enum": [ + "BatchService", + "UserSubscription" + ], + "x-ms-enum": { + "name": "PoolAllocationMode", + "modelAsString": false, + "values": [ + { + "value": "BatchService", + "description": "Pools will be allocated in subscriptions owned by the Batch service." + }, + { + "value": "UserSubscription", + "description": "Pools will be allocated in a subscription owned by the user." + } + ] + } + }, + "CertificateBaseProperties": { + "description": "Base certificate properties.", + "type": "object", + "properties": { + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm of the certificate thumbprint.", + "description": "This must match the first portion of the certificate name. Currently required to be 'SHA1'." + }, + "thumbprint": { + "type": "string", + "title": "The thumbprint of the certificate.", + "description": "This must match the thumbprint from the name." + }, + "format": { + "type": "string", + "x-nullable": false, + "description": "The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.", + "enum": [ + "Pfx", + "Cer" + ], + "x-ms-enum": { + "name": "CertificateFormat", + "modelAsString": false, + "values": [ + { + "value": "Pfx", + "description": "The certificate is a PFX (PKCS#12) formatted certificate or certificate chain." + }, + { + "value": "Cer", + "description": "The certificate is a base64-encoded X.509 certificate." + } + ] + } + } + } + }, + "CertificateProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "title": "The provisioned state of the resource", + "enum": [ + "Succeeded", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "CertificateProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The certificate is available for use in pools." + }, + { + "value": "Deleting", + "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools." + }, + { + "value": "Failed", + "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete." + } + ] + } + }, + "provisioningStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the certificate entered its current state.", + "readOnly": true + }, + "previousProvisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "description": "The previous provisioned state of the resource", + "enum": [ + "Succeeded", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "CertificateProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The certificate is available for use in pools." + }, + { + "value": "Deleting", + "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools." + }, + { + "value": "Failed", + "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete." + } + ] + } + }, + "previousProvisioningStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the certificate entered its previous state.", + "readOnly": true + }, + "publicData": { + "type": "string", + "readOnly": true, + "description": "The public key of the certificate." + }, + "deleteCertificateError": { + "readOnly": true, + "$ref": "#/definitions/DeleteCertificateError", + "title": "The error which occurred while deleting the certificate", + "description": "This is only returned when the certificate provisioningState is 'Failed'." + } + }, + "allOf": [ + { + "$ref": "#/definitions/CertificateBaseProperties" + } + ], + "description": "Certificate properties." + }, + "CertificateCreateOrUpdateProperties": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CertificateBaseProperties" + } + ], + "properties": { + "data": { + "type": "string", + "title": "The base64-encoded contents of the certificate.", + "description": "The maximum size is 10KB.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "password": { + "type": "string", + "title": "The password to access the certificate's private key.", + "description": "This must not be specified if the certificate format is Cer.", + "x-ms-secret": true + } + }, + "description": "Certificate properties for create operations", + "required": [ + "data" + ] + }, + "Certificate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateProperties", + "description": "The properties associated with the certificate." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a certificate." + }, + "CertificateCreateOrUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateCreateOrUpdateProperties", + "description": "The properties associated with the certificate." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a certificate." + }, + "ListCertificatesResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + }, + "description": "The collection of returned certificates." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "DeleteCertificateError": { + "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/DeleteCertificateError" + }, + "x-ms-identifiers": [ + "code" + ], + "description": "A list of additional details about the error." + } + }, + "required": [ + "code", + "message" + ], + "description": "An error response from the Batch service." + }, + "DetectorListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DetectorResponse" + }, + "description": "The collection of Batch account detectors returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Values returned by the List operation." + }, + "DetectorResponse": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DetectorResponseProperties", + "description": "The properties associated with the detector." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains the information for a detector." + }, + "DetectorResponseProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "A base64 encoded string that represents the content of a detector." + } + }, + "description": "Detector response properties." + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "The properties associated with the private link resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a private link resource." + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "type": "string", + "title": "The group id of the private link resource.", + "description": "The group id is used to establish the private link connection.", + "readOnly": true + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of required members that are used to establish the private link connection.", + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of required zone names for the private DNS resource name", + "readOnly": true + } + }, + "description": "Private link resource properties." + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties associated with the private endpoint connection." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a private link resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "title": "The provisioning state of the private endpoint connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Creating", + "description": "The connection is creating." + }, + { + "value": "Updating", + "description": "The user has requested that the connection status be updated, but the update operation has not yet completed. You may not reference the connection when connecting the Batch account." + }, + { + "value": "Deleting", + "description": "The connection is deleting." + }, + { + "value": "Succeeded", + "description": "The connection status is final and is ready for use if Status is Approved." + }, + { + "value": "Failed", + "description": "The user requested that the connection be updated and it failed. You may retry the update operation." + }, + { + "value": "Cancelled", + "description": "The user has cancelled the connection creation." + } + ] + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "readOnly": true, + "title": "The ARM resource identifier of the private endpoint." + }, + "groupIds": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "title": "The group id of the private endpoint connection.", + "description": "The value has one and only one group id." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "title": "The private link service connection state of the private endpoint connection." + } + }, + "description": "Private endpoint connection properties." + }, + "PrivateEndpoint": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.", + "readOnly": true + } + }, + "description": "The private endpoint of the private endpoint connection." + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", + "title": "The status for the private endpoint connection of Batch account" + }, + "description": { + "type": "string", + "title": "Description of the private Connection state" + }, + "actionsRequired": { + "type": "string", + "title": "Action required on the private connection state", + "readOnly": true + } + }, + "required": [ + "status" + ], + "description": "The private link service connection state of the private endpoint connection" + }, + "PrivateLinkServiceConnectionStatus": { + "type": "string", + "title": "The status of the Batch private endpoint connection", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": false, + "values": [ + { + "value": "Approved", + "description": "The private endpoint connection is approved and can be used to access Batch account" + }, + { + "value": "Pending", + "description": "The private endpoint connection is pending and cannot be used to access Batch account" + }, + { + "value": "Rejected", + "description": "The private endpoint connection is rejected and cannot be used to access Batch account" + }, + { + "value": "Disconnected", + "description": "The private endpoint connection is disconnected and cannot be used to access Batch account" + } + ] + } + }, + "Pool": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolProperties", + "description": "The properties associated with the pool." + }, + "identity": { + "title": "The type of identity used for the Batch Pool.", + "description": "The type of identity used for the Batch Pool.", + "$ref": "#/definitions/BatchPoolIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a pool." + }, + "PoolProperties": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "title": "The display name for the pool.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the pool.", + "description": "This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.", + "readOnly": true + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the pool.", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "title": "The current state of the pool.", + "enum": [ + "Succeeded", + "Deleting" + ], + "x-ms-enum": { + "name": "PoolProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The pool is available to run tasks subject to the availability of compute nodes." + }, + { + "value": "Deleting", + "description": "The user has requested that the pool be deleted, but the delete operation has not yet completed." + } + ] + }, + "readOnly": true + }, + "provisioningStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the pool entered its current state.", + "readOnly": true + }, + "allocationState": { + "type": "string", + "title": "Whether the pool is resizing.", + "enum": [ + "Steady", + "Resizing", + "Stopping" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": false, + "values": [ + { + "value": "Steady", + "description": "The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes." + }, + { + "value": "Resizing", + "description": "The pool is resizing; that is, compute nodes are being added to or removed from the pool." + }, + { + "value": "Stopping", + "description": "The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed." + } + ] + }, + "readOnly": true + }, + "allocationStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the pool entered its current allocation state.", + "readOnly": true + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + }, + "deploymentConfiguration": { + "$ref": "#/definitions/DeploymentConfiguration", + "title": "This property describes how the pool nodes will be deployed - using Cloud Services or Virtual Machines.", + "description": "Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS)." + }, + "currentDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The number of dedicated compute nodes currently in the pool.", + "readOnly": true + }, + "currentLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The number of Spot/low-priority compute nodes currently in the pool.", + "readOnly": true + }, + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Settings which configure the number of nodes in the pool." + }, + "autoScaleRun": { + "$ref": "#/definitions/AutoScaleRun", + "title": "The results and errors from the last execution of the autoscale formula.", + "description": "This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.", + "readOnly": true + }, + "interNodeCommunication": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "InterNodeCommunicationState", + "modelAsString": false, + "values": [ + { + "value": "Enabled", + "description": "Enable network communication between virtual machines." + }, + { + "value": "Disabled", + "description": "Disable network communication between virtual machines." + } + ] + }, + "title": "Whether the pool permits direct communication between nodes.", + "description": "This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the pool." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "default": 1, + "title": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.", + "description": "The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/TaskSchedulingPolicy", + "title": "How tasks are distributed across compute nodes in a pool.", + "description": "If not specified, the default is spread." + }, + "userAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "x-ms-identifiers": [ + "name" + ], + "title": "The list of user accounts to be created on each node in the pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [ + "name" + ], + "title": "A list of name-value pairs associated with the pool as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A task specified to run on each compute node as it joins the pool.", + "description": "In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool." + }, + "certificates": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of certificates to be installed on each compute node in the pool.", + "description": "For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.\n\nWarning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead." + }, + "applicationPackages": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of application packages to be installed on each compute node in the pool.", + "description": "Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool." + }, + "applicationLicenses": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of application licenses the Batch service will make available on each compute node in the pool.", + "description": "The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail." + }, + "resizeOperationStatus": { + "$ref": "#/definitions/ResizeOperationStatus", + "title": "Contains details about the current or last completed resize operation.", + "readOnly": true + }, + "mountConfiguration": { + "type": "array", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "x-ms-identifiers": [], + "title": "A list of file systems to mount on each node in the pool.", + "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse." + }, + "targetNodeCommunicationMode": { + "title": "The desired node communication mode for the pool.", + "description": "If omitted, the default value is Default.", + "$ref": "#/definitions/NodeCommunicationMode" + }, + "currentNodeCommunicationMode": { + "title": "The current state of the pool communication mode.", + "$ref": "#/definitions/NodeCommunicationMode", + "x-nullable": true, + "readOnly": true + }, + "resourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "The user-specified tags associated with the pool.", + "description": "The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'." + } + }, + "description": "Pool properties." + }, + "BatchPoolIdentity": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identity used for the Batch Pool.", + "enum": [ + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "PoolIdentityType", + "modelAsString": false, + "values": [ + { + "value": "UserAssigned", + "description": "Batch pool has user assigned identities with it." + }, + { + "value": "None", + "description": "Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities." + } + ] + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the Batch pool.", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentities" + } + } + }, + "description": "The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities", + "required": [ + "type" + ] + }, + "DeploymentConfiguration": { + "type": "object", + "properties": { + "cloudServiceConfiguration": { + "$ref": "#/definitions/CloudServiceConfiguration", + "title": "The cloud service configuration for the pool.", + "description": "This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "title": "The virtual machine configuration for the pool.", + "description": "This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified." + } + }, + "title": "Deployment configuration properties." + }, + "ScaleSettings": { + "type": "object", + "properties": { + "fixedScale": { + "$ref": "#/definitions/FixedScaleSettings", + "title": "Fixed scale settings for the pool.", + "description": "This property and autoScale are mutually exclusive and one of the properties must be specified." + }, + "autoScale": { + "$ref": "#/definitions/AutoScaleSettings", + "title": "AutoScale settings for the pool.", + "description": "This property and fixedScale are mutually exclusive and one of the properties must be specified." + } + }, + "title": "Scale settings for the pool", + "description": "Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes." + }, + "AutoScaleSettings": { + "type": "object", + "properties": { + "formula": { + "type": "string", + "title": "A formula for the desired number of compute nodes in the pool.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/batch/batch-automatic-scaling", + "description": "Create an automatic scaling formula for scaling compute nodes in a Batch pool" + } + }, + "evaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the pool size according to the autoscale formula.", + "description": "If omitted, the default value is 15 minutes (PT15M)." + } + }, + "required": [ + "formula" + ], + "title": "AutoScale settings for the pool." + }, + "FixedScaleSettings": { + "type": "object", + "properties": { + "resizeTimeout": { + "type": "string", + "format": "duration", + "default": "PT15M", + "title": "The timeout for allocation of compute nodes to the pool.", + "description": "The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool.", + "description": "At least one of targetDedicatedNodes, targetLowPriorityNodes must be set." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of Spot/low-priority compute nodes in the pool.", + "description": "At least one of targetDedicatedNodes, targetLowPriorityNodes must be set." + }, + "nodeDeallocationOption": { + "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.", + "description": "If omitted, the default value is Requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption", + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "title": "Fixed scale settings for the pool." + }, + "ComputeNodeDeallocationOption": { + "type": "string", + "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", + "enum": [ + "Requeue", + "Terminate", + "TaskCompletion", + "RetainedData" + ], + "x-ms-enum": { + "name": "ComputeNodeDeallocationOption", + "modelAsString": false, + "values": [ + { + "value": "Requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "Terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "TaskCompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed." + }, + { + "value": "RetainedData", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired." + } + ] + } + }, + "CertificateReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool." + }, + "storeLocation": { + "type": "string", + "title": "The location of the certificate store on the compute node into which to install the certificate.", + "description": "The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.", + "enum": [ + "CurrentUser", + "LocalMachine" + ], + "x-ms-enum": { + "name": "CertificateStoreLocation", + "modelAsString": false, + "values": [ + { + "value": "CurrentUser", + "description": "Certificates should be installed to the CurrentUser certificate store." + }, + { + "value": "LocalMachine", + "description": "Certificates should be installed to the LocalMachine certificate store." + } + ] + } + }, + "storeName": { + "type": "string", + "title": "The name of the certificate store on the compute node into which to install the certificate.", + "description": "This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My." + }, + "visibility": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "enum": [ + "StartTask", + "Task", + "RemoteUser" + ], + "x-ms-enum": { + "name": "CertificateVisibility", + "modelAsString": false, + "values": [ + { + "value": "StartTask", + "description": "The certificate should be visible to the user account under which the start task is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well." + }, + { + "value": "Task", + "description": "The certificate should be visible to the user accounts under which job tasks are run." + }, + { + "value": "RemoteUser", + "description": "The certificate should be visible to the user accounts under which users remotely access the node." + } + ] + } + }, + "title": "Which user accounts on the compute node should have access to the private data of the certificate." + } + }, + "required": [ + "id" + ], + "title": "A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool.", + "description": "Warning: This object is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead." + }, + "ApplicationPackageReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists." + }, + "version": { + "type": "string", + "title": "The version of the application to deploy. If omitted, the default version is deployed.", + "description": "If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409." + } + }, + "title": "Link to an application package inside the batch account", + "required": [ + "id" + ] + }, + "ResizeError": { + "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." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "x-ms-identifiers": [ + "code" + ], + "title": "Additional details about the error." + } + }, + "title": "An error that occurred when resizing a pool.", + "required": [ + "code", + "message" + ] + }, + "AutoScaleRunError": { + "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." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoScaleRunError" + }, + "x-ms-identifiers": [ + "code" + ], + "title": "Additional details about the error." + } + }, + "title": "An error that occurred when autoscaling a pool.", + "required": [ + "code", + "message" + ] + }, + "AutoScaleRun": { + "type": "object", + "properties": { + "evaluationTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the autoscale formula was last evaluated." + }, + "results": { + "type": "string", + "title": "The final values of all variables used in the evaluation of the autoscale formula.", + "description": "Each variable value is returned in the form $variable=value, and variables are separated by semicolons." + }, + "error": { + "$ref": "#/definitions/AutoScaleRunError", + "title": "Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful." + } + }, + "required": [ + "evaluationTime" + ], + "title": "The results and errors from an execution of a pool autoscale formula." + }, + "NodeCommunicationMode": { + "type": "string", + "title": "Determines how a pool communicates with the Batch service.", + "enum": [ + "Default", + "Classic", + "Simplified" + ], + "x-ms-enum": { + "name": "NodeCommunicationMode", + "modelAsString": false, + "values": [ + { + "value": "Default", + "description": "The node communication mode is automatically set by the Batch service." + }, + { + "value": "Classic", + "description": "Nodes using the Classic communication mode require inbound TCP communication on ports 29876 and 29877 from the \"BatchNodeManagement.{region}\" service tag and outbound TCP communication on port 443 to the \"Storage.region\" and \"BatchNodeManagement.{region}\" service tags." + }, + { + "value": "Simplified", + "description": "Nodes using the Simplified communication mode require outbound TCP communication on port 443 to the \"BatchNodeManagement.{region}\" service tag. No open inbound ports are required." + } + ] + } + }, + "ServiceArtifactReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "title": "The service artifact reference id of ServiceArtifactReference", + "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + }, + "required": [ + "id" + ], + "description": "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." + }, + "VirtualMachineConfiguration": { + "type": "object", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "title": "A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use." + }, + "nodeAgentSkuId": { + "type": "string", + "title": "The SKU of the Batch node agent to be provisioned on compute nodes in the pool.", + "description": "The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "title": "Windows operating system settings on the virtual machine.", + "description": "This property must not be specified if the imageReference specifies a Linux OS image." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "x-ms-identifiers": [ + "lun" + ], + "title": "The configuration for data disks attached to the compute nodes in the pool.", + "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them." + }, + "licenseType": { + "type": "string", + "title": "The type of on-premises license to be used when deploying the operating system.", + "description": "This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:\n\n Windows_Server - The on-premises license is for Windows Server.\n Windows_Client - The on-premises license is for Windows Client.\n" + }, + "containerConfiguration": { + "$ref": "#/definitions/ContainerConfiguration", + "title": "The container configuration for the pool.", + "description": "If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it." + }, + "diskEncryptionConfiguration": { + "$ref": "#/definitions/DiskEncryptionConfiguration", + "title": "The disk encryption configuration for the pool.", + "description": "If specified, encryption is performed on each node in the pool during node provisioning." + }, + "nodePlacementConfiguration": { + "$ref": "#/definitions/NodePlacementConfiguration", + "title": "The node placement configuration for the pool.", + "description": "This configuration will specify rules on how nodes in the pool will be physically allocated." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VMExtension" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "title": "The virtual machine extension for the pool.", + "description": "If specified, the extensions mentioned in this configuration will be installed on each node." + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "title": "Settings for the operating system disk of the Virtual Machine.", + "description": "Contains configuration for ephemeral OSDisk settings." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "title": "Specifies the security profile settings for the virtual machine or virtual machine scale set." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReference", + "title": "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.", + "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + }, + "required": [ + "imageReference", + "nodeAgentSkuId" + ], + "title": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure." + }, + "ContainerRegistry": { + "type": "object", + "properties": { + "username": { + "type": "string", + "x-ms-client-name": "userName", + "title": "The user name to log into the registry server." + }, + "password": { + "type": "string", + "title": "The password to log into the registry server.", + "x-ms-secret": true + }, + "registryServer": { + "type": "string", + "title": "The registry URL.", + "description": "If omitted, the default is \"docker.io\"." + }, + "identityReference": { + "title": "The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.", + "$ref": "#/definitions/ComputeNodeIdentityReference" + } + }, + "title": "A private container registry." + }, + "DiskEncryptionConfiguration": { + "type": "object", + "properties": { + "targets": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "title": "The disks to encrypt on each compute node.", + "description": "If omitted, no disks on the compute nodes in the pool will be encrypted.", + "enum": [ + "OsDisk", + "TemporaryDisk" + ], + "x-ms-enum": { + "name": "DiskEncryptionTarget", + "modelAsString": false, + "values": [ + { + "value": "OsDisk", + "description": "The OS Disk on the compute node is encrypted.", + "name": "OsDisk" + }, + { + "value": "TemporaryDisk", + "description": "The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time.", + "name": "TemporaryDisk" + } + ] + } + }, + "title": "The list of disk targets Batch Service will encrypt on the compute node", + "description": "On Linux pool, only \"TemporaryDisk\" is supported; on Windows pool, \"OsDisk\" and \"TemporaryDisk\" must be specified." + } + }, + "description": "The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Azure Compute Gallery Image." + }, + "ContainerConfiguration": { + "type": "object", + "properties": { + "type": { + "type": "string", + "title": "The container technology to be used.", + "enum": [ + "DockerCompatible", + "CriCompatible" + ], + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true, + "values": [ + { + "value": "DockerCompatible", + "description": "A Docker compatible container technology will be used to launch the containers." + }, + { + "value": "CriCompatible", + "description": "A CRI based technology will be used to launch the containers." + } + ] + } + }, + "containerImageNames": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The collection of container image names.", + "description": "This is the full image reference, as would be specified to \"docker pull\". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry." + }, + "containerRegistries": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistry" + }, + "x-ms-identifiers": [ + "registryServer" + ], + "title": "Additional private registries from which containers can be pulled.", + "description": "If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here." + } + }, + "required": [ + "type" + ], + "title": "The configuration for container-enabled pools." + }, + "NodePlacementPolicyType": { + "type": "string", + "title": "The placement policy for allocating nodes in the pool.", + "description": "The default value is regional.", + "enum": [ + "Regional", + "Zonal" + ], + "x-ms-enum": { + "name": "NodePlacementPolicyType", + "modelAsString": false, + "values": [ + { + "value": "Regional", + "description": "All nodes in the pool will be allocated in the same region." + }, + { + "value": "Zonal", + "description": "Nodes in the pool will be spread across different zones with best effort balancing.", + "name": "Zonal" + } + ] + } + }, + "NodePlacementConfiguration": { + "title": "Node placement configuration for batch pools.", + "description": "Allocation configuration used by Batch Service to provision the nodes.", + "type": "object", + "properties": { + "policy": { + "$ref": "#/definitions/NodePlacementPolicyType", + "title": "Node placement Policy type on Batch Pools.", + "description": "Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy." + } + } + }, + "VMExtension": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The name of the virtual machine extension." + }, + "publisher": { + "type": "string", + "title": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "title": "The type of the extensions." + }, + "typeHandlerVersion": { + "type": "string", + "title": "The version of script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "title": "JSON formatted public settings for the extension." + }, + "protectedSettings": { + "x-ms-secret": true, + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. " + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The collection of extension names.", + "description": "Collection of extension names after which this extension needs to be provisioned." + } + }, + "required": [ + "name", + "publisher", + "type" + ], + "title": "The configuration for virtual machine extensions." + }, + "WindowsConfiguration": { + "type": "object", + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "title": "Whether automatic updates are enabled on the virtual machine.", + "description": "If omitted, the default value is true." + } + }, + "title": "Windows operating system settings to apply to the virtual machine." + }, + "ImageReference": { + "type": "object", + "properties": { + "publisher": { + "type": "string", + "title": "The publisher of the Azure Virtual Machines Marketplace image.", + "description": "For example, Canonical or MicrosoftWindowsServer." + }, + "offer": { + "type": "string", + "title": "The offer type of the Azure Virtual Machines Marketplace image.", + "description": "For example, UbuntuServer or WindowsServer." + }, + "sku": { + "type": "string", + "title": "The SKU of the Azure Virtual Machines Marketplace image.", + "description": "For example, 18.04-LTS or 2022-datacenter." + }, + "version": { + "type": "string", + "title": "The version of the Azure Virtual Machines Marketplace image.", + "default": "latest", + "description": "A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." + }, + "id": { + "type": "string", + "title": "The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.", + "description": "This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + } + }, + "title": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation." + }, + "DataDisk": { + "type": "object", + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "title": "The logical unit number.", + "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive." + }, + "caching": { + "$ref": "#/definitions/CachingType", + "title": "The type of caching to be enabled for the data disks.", + "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in GB when creating new data disk." + }, + "storageAccountType": { + "title": "The storage account type to be used for the data disk.", + "description": "If omitted, the default is \"Standard_LRS\". Values are:\n\n Standard_LRS - The data disk should use standard locally redundant storage.\n Premium_LRS - The data disk should use premium locally redundant storage.", + "$ref": "#/definitions/StorageAccountType" + } + }, + "required": [ + "lun", + "diskSizeGB" + ], + "description": "Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them." + }, + "TaskSchedulingPolicy": { + "type": "object", + "properties": { + "nodeFillType": { + "type": "string", + "default": "Spread", + "title": "How tasks should be distributed across compute nodes.", + "enum": [ + "Spread", + "Pack" + ], + "x-ms-enum": { + "name": "ComputeNodeFillType", + "modelAsString": false, + "values": [ + { + "value": "Spread", + "description": "Tasks should be assigned evenly across all nodes in the pool." + }, + { + "value": "Pack", + "description": "As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool." + } + ] + } + } + }, + "required": [ + "nodeFillType" + ], + "title": "Specifies how tasks should be distributed across compute nodes." + }, + "LinuxUserConfiguration": { + "type": "object", + "properties": { + "uid": { + "type": "integer", + "format": "int32", + "title": "The user ID of the user account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid." + }, + "gid": { + "type": "integer", + "format": "int32", + "title": "The group ID for the user account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid." + }, + "sshPrivateKey": { + "type": "string", + "title": "The SSH private key for the user account.", + "description": "The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).", + "x-ms-secret": true + } + }, + "title": "Properties used to create a user account on a Linux node." + }, + "WindowsUserConfiguration": { + "type": "object", + "properties": { + "loginMode": { + "type": "string", + "title": "Login mode for user", + "description": "Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.", + "enum": [ + "Batch", + "Interactive" + ], + "x-ms-enum": { + "name": "LoginMode", + "modelAsString": false, + "values": [ + { + "value": "Batch", + "description": "The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes." + }, + { + "value": "Interactive", + "description": "The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended." + } + ] + } + } + }, + "title": "Properties used to create a user account on a Windows node." + }, + "UserAccount": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The name of the user account. Names can contain any Unicode characters up to a maximum length of 20." + }, + "password": { + "type": "string", + "title": "The password for the user account.", + "x-ms-secret": true + }, + "elevationLevel": { + "title": "The elevation level of the user account.", + "description": "nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.", + "$ref": "#/definitions/ElevationLevel" + }, + "linuxUserConfiguration": { + "title": "The Linux-specific user configuration for the user account.", + "description": "This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.", + "$ref": "#/definitions/LinuxUserConfiguration" + }, + "windowsUserConfiguration": { + "title": "The Windows-specific user configuration for the user account.", + "description": "This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.", + "$ref": "#/definitions/WindowsUserConfiguration" + } + }, + "required": [ + "name", + "password" + ], + "title": "Properties used to create a user on an Azure Batch node." + }, + "StartTask": { + "type": "object", + "properties": { + "commandLine": { + "type": "string", + "title": "The command line of the start task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. Required if any other properties of the startTask are specified." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [ + "httpUrl" + ], + "title": "A list of files that the Batch service will download to the compute node before running the command line." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [ + "name" + ], + "title": "A list of environment variable settings for the start task." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the start task runs.", + "description": "If omitted, the task runs as a non-administrative user unique to the task." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "default": 0, + "title": "The maximum number of times the task may be retried.", + "description": "The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0" + }, + "waitForSuccess": { + "type": "boolean", + "title": "Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.", + "description": "If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the start task runs.", + "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container." + } + }, + "title": "A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.", + "description": "In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task." + }, + "TaskContainerSettings": { + "type": "object", + "properties": { + "containerRunOptions": { + "type": "string", + "title": "Additional options to the container create command.", + "description": "These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service." + }, + "imageName": { + "type": "string", + "title": "The image to use to create the container in which the task will run.", + "description": "This is the full image reference, as would be specified to \"docker pull\". If no tag is provided as part of the image name, the tag \":latest\" is used as a default." + }, + "registry": { + "$ref": "#/definitions/ContainerRegistry", + "title": "The private registry which contains the container image.", + "description": "This setting can be omitted if was already provided at pool creation." + }, + "workingDirectory": { + "type": "string", + "title": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.", + "enum": [ + "TaskWorkingDirectory", + "ContainerImageDefault" + ], + "x-ms-enum": { + "name": "ContainerWorkingDirectory", + "modelAsString": false, + "values": [ + { + "value": "TaskWorkingDirectory", + "description": "Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch." + }, + { + "value": "ContainerImageDefault", + "description": "Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch." + } + ] + } + } + }, + "required": [ + "imageName" + ], + "title": "The container settings for a task." + }, + "ResourceFile": { + "type": "object", + "properties": { + "autoStorageContainerName": { + "type": "string", + "title": "The storage container name in the auto storage account.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified." + }, + "storageContainerUrl": { + "type": "string", + "title": "The URL of the blob container within Azure Blob Storage.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access." + }, + "httpUrl": { + "type": "string", + "title": "The URL of the file to download.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access." + }, + "blobPrefix": { + "type": "string", + "title": "The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.", + "description": "The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded." + }, + "filePath": { + "type": "string", + "title": "The location on the compute node to which to download the file, relative to the task's working directory.", + "description": "If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..')." + }, + "fileMode": { + "type": "string", + "title": "The file permission mode attribute in octal format.", + "description": "This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file." + }, + "identityReference": { + "title": "The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl", + "$ref": "#/definitions/ComputeNodeIdentityReference" + } + }, + "title": "A single file or multiple files to be downloaded to a compute node." + }, + "EnvironmentSetting": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The name of the environment variable." + }, + "value": { + "type": "string", + "title": "The value of the environment variable." + } + }, + "required": [ + "name" + ], + "title": "An environment variable to be set on a task process." + }, + "UserIdentity": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "title": "The name of the user identity under which the task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + }, + "autoUser": { + "$ref": "#/definitions/AutoUserSpecification", + "title": "The auto user under which the task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + } + }, + "title": "The definition of the user identity under which the task is run.", + "description": "Specify either the userName or autoUser property, but not both." + }, + "UserAssignedIdentities": { + "type": "object", + "description": "The list of associated user identities.", + "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." + } + } + }, + "ComputeNodeIdentityReference": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "The ARM resource id of the user assigned identity." + } + }, + "description": "The reference to a user assigned identity associated with the Batch pool which a compute node will use." + }, + "AutoUserSpecification": { + "type": "object", + "properties": { + "scope": { + "type": "string", + "title": "The scope for the auto user", + "description": "The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.", + "enum": [ + "Task", + "Pool" + ], + "x-ms-enum": { + "name": "AutoUserScope", + "modelAsString": false, + "values": [ + { + "value": "Task", + "description": "Specifies that the service should create a new user for the task." + }, + { + "value": "Pool", + "description": "Specifies that the task runs as the common auto user account which is created on every node in a pool." + } + ] + } + }, + "elevationLevel": { + "title": "The elevation level of the auto user.", + "description": "The default value is nonAdmin.", + "$ref": "#/definitions/ElevationLevel" + } + }, + "title": "Specifies the parameters for the auto user that runs a task on the Batch service." + }, + "ElevationLevel": { + "type": "string", + "title": "The elevation level of the user.", + "enum": [ + "NonAdmin", + "Admin" + ], + "x-ms-enum": { + "name": "ElevationLevel", + "modelAsString": false, + "values": [ + { + "value": "NonAdmin", + "description": "The user is a standard user without elevated access." + }, + { + "value": "Admin", + "description": "The user is a user with elevated access and operates with full Administrator permissions." + } + ] + } + }, + "StorageAccountType": { + "type": "string", + "title": "The storage account type for use in creating data disks or OS disk.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": false, + "values": [ + { + "value": "Standard_LRS", + "description": "The data disk / OS disk should use standard locally redundant storage." + }, + { + "value": "Premium_LRS", + "description": "The data disk / OS disk should use premium locally redundant storage." + }, + { + "value": "StandardSSD_LRS", + "description": "The data disk / OS disk should use standard SSD locally redundant storage." + } + ] + } + }, + "CachingType": { + "type": "string", + "title": "The type of caching to enable for the disk.", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingType", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "The caching mode for the disk is not enabled." + }, + { + "value": "ReadOnly", + "description": "The caching mode for the disk is read only." + }, + { + "value": "ReadWrite", + "description": "The caching mode for the disk is read and write." + } + ] + } + }, + "DiffDiskPlacement": { + "type": "string", + "title": "Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.", + "description": "This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements", + "enum": [ + "CacheDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": false, + "values": [ + { + "value": "CacheDisk", + "description": "The Ephemeral OS Disk is stored on the VM cache.", + "name": "CacheDisk" + } + ] + } + }, + "DiffDiskSettings": { + "type": "object", + "properties": { + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "title": "Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.", + "description": "This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements." + } + }, + "title": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + }, + "OSDisk": { + "type": "object", + "properties": { + "ephemeralOSDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "title": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + }, + "caching": { + "$ref": "#/definitions/CachingType", + "title": "Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage." + }, + "managedDisk": { + "$ref": "#/definitions/ManagedDisk", + "title": "The managed disk parameters." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in GB when creating new OS disk." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "title": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + }, + "title": "Settings for the operating system disk of the virtual machine." + }, + "IPAddressProvisioningType": { + "type": "string", + "title": "The provisioning type for Public IP Addresses for the Batch Pool.", + "enum": [ + "BatchManaged", + "UserManaged", + "NoPublicIPAddresses" + ], + "x-ms-enum": { + "name": "IPAddressProvisioningType", + "modelAsString": false, + "values": [ + { + "value": "BatchManaged", + "description": "A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool." + }, + { + "value": "UserManaged", + "description": "Public IPs are provided by the user and will be used to provision the Compute Nodes." + }, + { + "value": "NoPublicIPAddresses", + "description": "No public IP Address will be created for the Compute Nodes in the Pool." + } + ] + } + }, + "PublicIPAddressConfiguration": { + "type": "object", + "properties": { + "provision": { + "$ref": "#/definitions/IPAddressProvisioningType", + "title": "The provisioning type for Public IP Addresses for the pool", + "description": "The default value is BatchManaged" + }, + "ipAddressIds": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of public IPs which the Batch service will use when provisioning Compute Nodes.", + "description": "The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}." + } + }, + "description": "The public IP Address configuration of the networking configuration of a Pool." + }, + "NetworkConfiguration": { + "type": "object", + "properties": { + "subnetId": { + "type": "string", + "title": "The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.", + "description": "The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor", + "description": "Setting up RBAC for Azure Batch VNets" + } + }, + "dynamicVnetAssignmentScope": { + "type": "string", + "title": "The scope of dynamic vnet assignment.", + "default": "none", + "enum": [ + "none", + "job" + ], + "x-ms-enum": { + "name": "DynamicVNetAssignmentScope", + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "No dynamic VNet assignment is enabled." + }, + { + "value": "job", + "description": "Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support" + } + ] + } + }, + "endpointConfiguration": { + "$ref": "#/definitions/PoolEndpointConfiguration", + "title": "The configuration for endpoints on compute nodes in the Batch pool.", + "description": "Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/PublicIPAddressConfiguration", + "title": "The Public IPAddress configuration for Compute Nodes in the Batch Pool.", + "description": "This property is only supported on Pools with the virtualMachineConfiguration property." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "title": "Whether this pool should enable accelerated networking.", + "description": "Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview", + "description": "Create a VM with Accelerated Networking." + } + } + }, + "description": "The network configuration for a pool." + }, + "CloudServiceConfiguration": { + "type": "object", + "properties": { + "osFamily": { + "type": "string", + "title": "The Azure Guest OS family to be installed on the virtual machines in the pool.", + "description": "Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases)." + }, + "osVersion": { + "type": "string", + "title": "The Azure Guest OS version to be installed on the virtual machines in the pool.", + "description": "The default value is * which specifies the latest operating system version for the specified OS family." + } + }, + "required": [ + "osFamily" + ], + "title": "The configuration for nodes in a pool based on the Azure Cloud Services platform." + }, + "MetadataItem": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The name of the metadata item." + }, + "value": { + "type": "string", + "title": "The value of the metadata item." + } + }, + "required": [ + "name", + "value" + ], + "title": "A name-value pair associated with a Batch service resource.", + "description": "The Batch service does not assign any meaning to this metadata; it is solely for the use of user code." + }, + "ResizeOperationStatus": { + "type": "object", + "properties": { + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of Spot/low-priority compute nodes in the pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.", + "description": "The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "nodeDeallocationOption": { + "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.", + "description": "The default value is requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time when this resize operation was started." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "x-ms-identifiers": [ + "code" + ], + "title": "Details of any errors encountered while performing the last resize on the pool.", + "description": "This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady." + } + }, + "title": "Details about the current or last completed resize operation.", + "description": "Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady)." + }, + "PoolEndpointConfiguration": { + "type": "object", + "properties": { + "inboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatPool" + }, + "x-ms-identifiers": [ + "name" + ], + "title": "A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally.", + "description": "The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses." + } + }, + "required": [ + "inboundNatPools" + ], + "title": "The endpoint configuration for a pool." + }, + "InboundNatPool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The name of the endpoint.", + "description": "The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400." + }, + "protocol": { + "type": "string", + "title": "The protocol of the endpoint.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "InboundEndpointProtocol", + "modelAsString": false, + "values": [ + { + "value": "TCP", + "description": "Use TCP for the endpoint." + }, + { + "value": "UDP", + "description": "Use UDP for the endpoint." + } + ] + } + }, + "backendPort": { + "type": "integer", + "format": "int32", + "title": "The port number on the compute node.", + "description": "This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "title": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "title": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "networkSecurityGroupRules": { + "type": "array", + "title": "A list of network security group rules that will be applied to the endpoint.", + "description": "The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.", + "items": { + "$ref": "#/definitions/NetworkSecurityGroupRule" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name", + "protocol", + "backendPort", + "frontendPortRangeStart", + "frontendPortRangeEnd" + ], + "title": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally." + }, + "NetworkSecurityGroupRule": { + "type": "object", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority for this rule.", + "description": "Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400." + }, + "access": { + "type": "string", + "title": "The action that should be taken for a specified IP address, subnet range or tag.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "NetworkSecurityGroupRuleAccess", + "modelAsString": false, + "values": [ + { + "value": "Allow", + "description": "Allow access." + }, + { + "value": "Deny", + "description": "Deny access." + } + ] + } + }, + "sourceAddressPrefix": { + "type": "string", + "title": "The source address prefix or tag to match for the rule.", + "description": "Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The source port ranges to match for the rule.", + "description": "Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *." + } + }, + "required": [ + "priority", + "access", + "sourceAddressPrefix" + ], + "title": "A network security group rule to apply to an inbound endpoint." + }, + "ListPrivateLinkResourcesResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "The collection of returned private link resources." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "ListPrivateEndpointConnectionsResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The collection of returned private endpoint connection." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "ListPoolsResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Pool" + }, + "description": "The collection of returned pools." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "description": "The body of the error response.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Batch 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": [ + "message", + "target" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Batch service." + }, + "SkuCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the feature." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "The value of the feature." + } + }, + "description": "A SKU capability, such as the number of cores." + }, + "SupportedSku": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the SKU." + }, + "familyName": { + "readOnly": true, + "type": "string", + "description": "The family name of the SKU." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SkuCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A collection of capabilities which this SKU supports." + } + }, + "description": "Describes a Batch supported SKU." + }, + "SupportedSkusResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SupportedSku" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of SKUs available for the Batch service in the location." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "required": [ + "value" + ], + "description": "The Batch List supported SKUs operation response." + }, + "Operation": { + "title": "A REST API operation", + "type": "object", + "properties": { + "name": { + "title": "The operation name.", + "description": "This is of the format {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "title": "The object that describes the operation.", + "type": "object", + "properties": { + "provider": { + "title": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "title": "The operation type.", + "description": "For example: read, write, delete, or listKeys/action", + "type": "string" + }, + "resource": { + "title": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "title": "The friendly name of the operation", + "type": "string" + } + } + }, + "origin": { + "title": "The intended executor of the operation.", + "type": "string" + }, + "properties": { + "title": "Properties of the operation.", + "type": "object" + } + } + }, + "OperationListResult": { + "title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "title": "The list of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "title": "The URL to get the next set of operation list results if there are any." + } + } + }, + "CheckNameAvailabilityParameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name to check for availability" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Batch/batchAccounts" + ], + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": false, + "values": [ + { + "value": "Microsoft.Batch/batchAccounts", + "description": "The Batch account resource type.", + "name": "BatchAccounts" + } + ] + }, + "description": "The resource type." + } + }, + "required": [ + "name", + "type" + ], + "description": "Parameters for a check name availability request." + }, + "CheckNameAvailabilityResult": { + "type": "object", + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." + }, + "reason": { + "readOnly": true, + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameAvailabilityReason", + "modelAsString": false, + "values": [ + { + "value": "Invalid", + "description": "The requested name is invalid." + }, + { + "value": "AlreadyExists", + "description": "The requested name is already in use." + } + ] + }, + "description": "Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "MountConfiguration": { + "type": "object", + "properties": { + "azureBlobFileSystemConfiguration": { + "$ref": "#/definitions/AzureBlobFileSystemConfiguration", + "title": "The Azure Storage Container to mount using blob FUSE on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "nfsMountConfiguration": { + "$ref": "#/definitions/NFSMountConfiguration", + "title": "The NFS file system to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "cifsMountConfiguration": { + "$ref": "#/definitions/CIFSMountConfiguration", + "title": "The CIFS/SMB file system to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "azureFileShareConfiguration": { + "$ref": "#/definitions/AzureFileShareConfiguration", + "title": "The Azure File Share to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + } + }, + "title": "The file system to mount on each node." + }, + "AzureBlobFileSystemConfiguration": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "title": "The Azure Storage Account name." + }, + "containerName": { + "type": "string", + "title": "The Azure Blob Storage Container name." + }, + "accountKey": { + "type": "string", + "title": "The Azure Storage Account key.", + "description": "This property is mutually exclusive with both sasKey and identity; exactly one must be specified.", + "x-ms-secret": true + }, + "sasKey": { + "type": "string", + "title": "The Azure Storage SAS token.", + "description": "This property is mutually exclusive with both accountKey and identity; exactly one must be specified.", + "x-ms-secret": true + }, + "blobfuseOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "identityReference": { + "title": "The reference to the user assigned identity to use to access containerName", + "description": "This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified.", + "$ref": "#/definitions/ComputeNodeIdentityReference" + } + }, + "required": [ + "accountName", + "containerName", + "relativeMountPath" + ], + "title": "Information used to connect to an Azure Storage Container using Blobfuse." + }, + "NFSMountConfiguration": { + "type": "object", + "properties": { + "source": { + "type": "string", + "title": "The URI of the file system to mount." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + } + }, + "required": [ + "source", + "relativeMountPath" + ], + "title": "Information used to connect to an NFS file system." + }, + "CIFSMountConfiguration": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "title": "The user to use for authentication against the CIFS file system." + }, + "source": { + "type": "string", + "title": "The URI of the file system to mount." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + }, + "password": { + "type": "string", + "title": "The password to use for authentication against the CIFS file system.", + "x-ms-secret": true + } + }, + "required": [ + "userName", + "source", + "password", + "relativeMountPath" + ], + "title": "Information used to connect to a CIFS file system." + }, + "AzureFileShareConfiguration": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "title": "The Azure Storage account name." + }, + "azureFileUrl": { + "type": "string", + "title": "The Azure Files URL.", + "description": "This is of the form 'https://{account}.file.core.windows.net/'." + }, + "accountKey": { + "type": "string", + "title": "The Azure Storage account key.", + "x-ms-secret": true + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + } + }, + "required": [ + "accountName", + "azureFileUrl", + "relativeMountPath", + "accountKey" + ], + "title": "Information used to connect to an Azure Fileshare." + }, + "OutboundEnvironmentEndpointCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [], + "description": "The collection of outbound network dependency endpoints returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "OutboundEnvironmentEndpoint": { + "type": "object", + "properties": { + "category": { + "type": "string", + "readOnly": true, + "description": "The type of service that the Batch service connects to." + }, + "endpoints": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [ + "domainName" + ], + "description": "The endpoints for this service to which the Batch service makes outbound calls." + } + }, + "description": "A collection of related endpoints from the same service for which the Batch service requires outbound access." + }, + "EndpointDependency": { + "type": "object", + "properties": { + "domainName": { + "type": "string", + "readOnly": true, + "description": "The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Human-readable supplemental information about the dependency and when it is applicable." + }, + "endpointDetails": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [ + "port" + ], + "description": "The list of connection details for this endpoint." + } + }, + "description": "A domain name and connection details used to access a dependency." + }, + "EndpointDetail": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The port an endpoint is connected to." + } + }, + "description": "Details about the connection between the Batch service and the endpoint." + }, + "ManagedDisk": { + "type": "object", + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "title": "The storage account type for managed disk." + } + } + }, + "SecurityProfile": { + "type": "object", + "properties": { + "securityType": { + "type": "string", + "title": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.", + "enum": [ + "trustedLaunch" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": false, + "values": [ + { + "value": "trustedLaunch", + "description": "Trusted launch protects against advanced and persistent attack techniques." + } + ] + } + }, + "encryptionAtHost": { + "type": "boolean", + "description": "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." + }, + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "title": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine.", + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine." + } + }, + "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set." + }, + "UefiSettings": { + "type": "object", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Specifies whether vTPM should be enabled on the virtual machine." + } + }, + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group that contains the Batch account.", + "x-ms-parameter-location": "method" + }, + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+$", + "minLength": 3, + "maxLength": 24, + "description": "The name of the Batch account.", + "x-ms-parameter-location": "method" + }, + "CertificateNameParameter": { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[\\w]+-[\\w]+$", + "minLength": 5, + "maxLength": 45, + "description": "The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.", + "x-ms-parameter-location": "method" + }, + "DetectorIdParameter": { + "name": "detectorId", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the detector.", + "x-ms-parameter-location": "method" + }, + "PoolNameParameter": { + "name": "poolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "minLength": 1, + "maxLength": 64, + "description": "The pool name. This must be unique within the account.", + "x-ms-parameter-location": "method" + }, + "PrivateLinkResourceNameParameter": { + "name": "privateLinkResourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+\\.?[a-fA-F0-9-]*$", + "minLength": 1, + "maxLength": 101, + "description": "The private link resource name. This must be unique within the account.", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+\\.?[a-fA-F0-9-]*$", + "minLength": 1, + "maxLength": 101, + "description": "The private endpoint connection name. This must be unique within the account.", + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the application. This must be unique within the account.", + "x-ms-parameter-location": "method" + }, + "VersionNameParameter": { + "name": "versionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$", + "minLength": 1, + "maxLength": 64, + "description": "The version of the application.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationCreate.json new file mode 100644 index 000000000000..f445813e3d28 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationCreate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "applicationName": "app1", + "parameters": { + "properties": { + "allowUpdates": false, + "displayName": "myAppName" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64F8EBB3DC411\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F8EBB3DC411\"", + "properties": { + "allowUpdates": false, + "displayName": "myAppName" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationDelete.json new file mode 100644 index 000000000000..1fb83e3cf18e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "applicationName": "app1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationGet.json new file mode 100644 index 000000000000..2d82c1639f16 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "applicationName": "app1" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64F915BDF7F00\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F915BDF7F00\"", + "properties": { + "allowUpdates": true, + "displayName": "Sample Application" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationList.json new file mode 100644 index 000000000000..61ef0dc8d812 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F91A9089879\"", + "properties": { + "allowUpdates": false, + "defaultVersion": "1" + } + }, + { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app2", + "name": "app1", + "etag": "W/\"0x8D64F91A9089879\"", + "properties": { + "allowUpdates": false, + "defaultVersion": "2.0", + "displayName": "myAppName" + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageActivate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageActivate.json new file mode 100644 index 000000000000..5c9e033e5ad2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageActivate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1", + "parameters": { + "format": "zip" + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "name": "1", + "etag": "W/\"0x8D64FEC83A3B436\"", + "properties": { + "state": "Active", + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageCreate.json new file mode 100644 index 000000000000..7f38bf245e36 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageCreate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "name": "1", + "etag": "W/\"0x8D64FEC83A3B436\"", + "properties": { + "storageUrl": "http://mystorage1.blob.core.windows.net/myapp?mysas", + "storageUrlExpiry": "2017-06-27T18:48:09.9330991Z", + "state": "Pending" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageDelete.json new file mode 100644 index 000000000000..e41052449b0e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageGet.json new file mode 100644 index 000000000000..dd6a21f73c07 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "name": "1", + "etag": "W/\"0x8D64FEC83A3B436\"", + "properties": { + "state": "Active", + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageList.json new file mode 100644 index 000000000000..8c3d27bc0ee8 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationPackageList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "applicationName": "app1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1.0", + "name": "1.0", + "etag": "W/\"0x8D64FF0B9F47F67\"", + "properties": { + "state": "Pending" + } + }, + { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/2.0", + "name": "2.0", + "etag": "W/\"0x8D64FF0B9F47F67\"", + "properties": { + "state": "Active", + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationUpdate.json new file mode 100644 index 000000000000..948299350442 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/ApplicationUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "applicationName": "app1", + "parameters": { + "properties": { + "allowUpdates": true, + "displayName": "myAppName", + "defaultVersion": "2" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64F915BDF7F00\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F915BDF7F00\"", + "properties": { + "allowUpdates": true, + "displayName": "myAppName", + "defaultVersion": "2" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_BYOS.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_BYOS.json new file mode 100644 index 000000000000..e252863d378f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_BYOS.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "poolAllocationMode": "UserSubscription", + "keyVaultReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "UserSubscription", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "keyVaultReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_Default.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_Default.json new file mode 100644 index 000000000000..c0dda0618944 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_Default.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_SystemAssignedIdentity.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_SystemAssignedIdentity.json new file mode 100644 index 000000000000..323f90f902b1 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_SystemAssignedIdentity.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "type": "SystemAssigned" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_UserAssignedIdentity.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_UserAssignedIdentity.json new file mode 100644 index 000000000000..b13f1afd2666 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountCreate_UserAssignedIdentity.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountDelete.json new file mode 100644 index 000000000000..9a1aed1699f8 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Batch/locations/japaneast/accountOperationResults/sampleacct-30a022cb-a64f-4fd5-9289-8b38b342e9de?api-version=2023-11-01" + } + }, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountGet.json new file mode 100644 index 000000000000..33ce690f9a0d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountGetKeys.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountGetKeys.json new file mode 100644 index 000000000000..f844d153135d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountGetKeys.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountList.json new file mode 100644 index 000000000000..361b87081fa0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountListByResourceGroup.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountListByResourceGroup.json new file mode 100644 index 000000000000..28e783cf3a39 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..60b6b6a0aaed --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Azure Batch", + "endpoints": [ + { + "domainName": "sampleacct.japaneast.batch.azure.com", + "description": "Applicable to job manager tasks, tasks that use job scoped authentication, or any task that makes calls to Batch.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "japaneast.service.batch.azure.com", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Storage", + "endpoints": [ + { + "domainName": "autostorageaccountname.blob.core.windows.net", + "description": "AutoStorage endpoint for this Batch account. Applicable to all Azure Batch pools under this account.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.blob.core.windows.net", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.table.core.windows.net", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "domainName": "*.queue.core.windows.net", + "description": "Applicable to all Azure Batch pools.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Microsoft Package Repository", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "description": "Only applicable to pools containing a Mount Configuration. Learn about Mount Configurations in Batch at https://docs.microsoft.com/azure/batch/virtual-file-mount.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Key Vault", + "endpoints": [ + { + "domainName": "*.vault.azure.net", + "description": "Only applicable to pools containing a Disk Encryption Configuration and whose VM size does not support encryption at host. Learn more about disk encryption in Azure Batch at https://docs.microsoft.com/azure/batch/disk-encryption. Learn more about encryption at host and supported VM sizes at https://docs.microsoft.com/azure/virtual-machines/disks-enable-host-based-encryption-portal.", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountRegenerateKey.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountRegenerateKey.json new file mode 100644 index 000000000000..bae197ef2e96 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountRegenerateKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "parameters": { + "keyName": "Primary" + } + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountSynchronizeAutoStorageKeys.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountSynchronizeAutoStorageKeys.json new file mode 100644 index 000000000000..4ab24b844c1e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountSynchronizeAutoStorageKeys.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountUpdate.json new file mode 100644 index 000000000000..60579003fb0d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/BatchAccountUpdate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCancelDeletion.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCancelDeletion.json new file mode 100644 index 000000000000..c784e07f0f13 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCancelDeletion.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD513C3EDBB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD513C3EDBB\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "previousProvisioningState": "Failed", + "previousProvisioningStateTransitionTime": "2017-07-21T00:22:54.3299195Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCreate_Full.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCreate_Full.json new file mode 100644 index 000000000000..f0e2a3c518ae --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCreate_Full.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "parameters": { + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "data": "MIIJsgIBAzCCCW4GCSqGSIb3DQE...", + "password": "", + "format": "Pfx" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCreate_Minimal.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCreate_Minimal.json new file mode 100644 index 000000000000..36932aee3e01 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCreate_Minimal.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "parameters": { + "properties": { + "data": "MIIJsgIBAzCCCW4GCSqGSIb3DQE...", + "password": "" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCreate_MinimalCer.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCreate_MinimalCer.json new file mode 100644 index 000000000000..dd8c94db231a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateCreate_MinimalCer.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "parameters": { + "properties": { + "data": "MIICrjCCAZagAwI...", + "format": "Cer" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Cer", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateDelete.json new file mode 100644 index 000000000000..3a0b3a7c0e08 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "api-version": "2023-11-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Retry-After": "15", + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/certificateOperationResults/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e-8D4EDFF164A11C9?api-version=2022-01-01" + } + }, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateGet.json new file mode 100644 index 000000000000..9b68070244ad --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateGetWithDeletionError.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateGetWithDeletionError.json new file mode 100644 index 000000000000..759c8f51b518 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateGetWithDeletionError.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Failed", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "previousProvisioningState": "Deleting", + "previousProvisioningStateTransitionTime": "2017-07-21T00:15:25.5625498Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI...", + "deleteCertificateError": { + "code": "NodesReferencingCertificate", + "message": "The specified certificate is being used by the below mentioned node(s)\nRequestId:2dc78afc-b15b-42d2-8c85-39cb61a0799e\nTime:2017-08-28T10:22:52.8633406Z", + "target": "BatchAccount", + "details": [ + { + "code": "Nodes", + "message": "node1, node3" + } + ] + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateList.json new file mode 100644 index 000000000000..b30d85a4b016 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "api-version": "2023-11-01", + "maxResults": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates?api-version=2022-01-01&$skiptoken=NPK%3D28%3A2857p428pug%2022F53A7734C947B8NRK%3D45%3Asha1-c23dc7f22edc793856a7506fe66397ccb4a33b46SM%3D5%3AFalse" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateListWithFilter.json new file mode 100644 index 000000000000..c2e6990cad19 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateListWithFilter.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "api-version": "2023-11-01", + "$filter": "properties/provisioningStateTransitionTime gt '2017-05-01' or properties/provisioningState eq 'Failed'", + "$select": "properties/format,properties/provisioningState" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "provisioningState": "Failed", + "format": "Pfx" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-aeb228ffb0bf67a793d61dce263ebd16949f15a1", + "name": "sha1-aeb228ffb0bf67a793d61dce263ebd16949f15a1", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118572E0\"", + "properties": { + "provisioningState": "Failed", + "format": "Cer" + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateUpdate.json new file mode 100644 index 000000000000..36932aee3e01 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/CertificateUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "parameters": { + "properties": { + "data": "MIIJsgIBAzCCCW4GCSqGSIb3DQE...", + "password": "" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/DetectorGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/DetectorGet.json new file mode 100644 index 000000000000..c2bf0f358ab8 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/DetectorGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "detectorId": "poolsAndNodes" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Batch/batchAccounts/detectors", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/detectors/poolsAndNodes", + "name": "poolsAndNodes", + "properties": { + "value": "ew0KICAibWV0YWRhdGEiOiB7DQogICAgImlkIjogInBvb2xzQW5kTm9kZXMiLA0KICAgICJuYW1lIjogIlBvb2xzIGFuZCBOb2RlcyIsDQogICAgImRlc2NyaXB0aW9uIjogbnVsbCwNCiAgICAiYXV0aG9yIjogIiIsDQogICAgImNhdGVnb3J5IjogbnVsbCwNCiAgICAic3VwcG9ydFRvcGljTGlzdCI6IFsNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc3IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDYxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY1IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY2IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDcyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDgyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkzIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDk0IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfQ0KICAgIF0sDQogICAgImFuYWx5c2lzVHlwZXMiOiBudWxsLA0KICAgICJ0eXBlIjogIkFuYWx5c2lzIiwNCiAgICAic2NvcmUiOiAwLjANCiAgfSwNCiAgImRhdGFzZXQiOiBbXSwNCiAgInN0YXR1cyI6IHsNCiAgICAibWVzc2FnZSI6IG51bGwsDQogICAgInN0YXR1c0lkIjogNA0KICB9LA0KICAiZGF0YVByb3ZpZGVyc01ldGFkYXRhIjogbnVsbCwNCiAgInN1Z2dlc3RlZFV0dGVyYW5jZXMiOiBudWxsDQp9" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/DetectorList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/DetectorList.json new file mode 100644 index 000000000000..982a01946c9f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/DetectorList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Batch/batchAccounts/detectors", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/detectors/poolsAndNodes", + "name": "poolsAndNodes", + "properties": { + "value": "ew0KICAibWV0YWRhdGEiOiB7DQogICAgImlkIjogInBvb2xzQW5kTm9kZXMiLA0KICAgICJuYW1lIjogIlBvb2xzIGFuZCBOb2RlcyIsDQogICAgImRlc2NyaXB0aW9uIjogbnVsbCwNCiAgICAiYXV0aG9yIjogIiIsDQogICAgImNhdGVnb3J5IjogbnVsbCwNCiAgICAic3VwcG9ydFRvcGljTGlzdCI6IFsNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc3IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDYxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY1IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY2IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDcyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDgyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkzIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDk0IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfQ0KICAgIF0sDQogICAgImFuYWx5c2lzVHlwZXMiOiBudWxsLA0KICAgICJ0eXBlIjogIkFuYWx5c2lzIiwNCiAgICAic2NvcmUiOiAwLjANCiAgfSwNCiAgImRhdGFzZXQiOiBbXSwNCiAgInN0YXR1cyI6IHsNCiAgICAibWVzc2FnZSI6IG51bGwsDQogICAgInN0YXR1c0lkIjogNA0KICB9LA0KICAiZGF0YVByb3ZpZGVyc01ldGFkYXRhIjogbnVsbCwNCiAgInN1Z2dlc3RlZFV0dGVyYW5jZXMiOiBudWxsDQp9" + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationCheckNameAvailability_AlreadyExists.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationCheckNameAvailability_AlreadyExists.json new file mode 100644 index 000000000000..7b1a9fe1ad06 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationCheckNameAvailability_AlreadyExists.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "subid", + "locationName": "japaneast", + "parameters": { + "name": "existingaccountname", + "type": "Microsoft.Batch/batchAccounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "An account named 'existingaccountname' is already in use." + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationCheckNameAvailability_Available.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationCheckNameAvailability_Available.json new file mode 100644 index 000000000000..d69e27d7437f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationCheckNameAvailability_Available.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "subid", + "locationName": "japaneast", + "parameters": { + "name": "newaccountname", + "type": "Microsoft.Batch/batchAccounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationGetQuotas.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationGetQuotas.json new file mode 100644 index 000000000000..9d8e0cae55f8 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationGetQuotas.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "subid", + "locationName": "japaneast" + }, + "responses": { + "200": { + "body": { + "accountQuota": 1 + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationListCloudServiceSkus.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationListCloudServiceSkus.json new file mode 100644 index 000000000000..7135421946c6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationListCloudServiceSkus.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "subid", + "locationName": "japaneast" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Small", + "familyName": "standardA0_A7Family", + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "0.75" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + } + ] + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationListVirtualMachineSkus.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationListVirtualMachineSkus.json new file mode 100644 index 000000000000..75c4e28b0052 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/LocationListVirtualMachineSkus.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "subid", + "locationName": "japaneast" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_D1_v2", + "familyName": "standardDFamily", + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "0.75" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + } + ] + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/OperationsList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/OperationsList.json new file mode 100644 index 000000000000..408fb2d16860 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/OperationsList.json @@ -0,0 +1,1219 @@ +{ + "parameters": { + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Accounts", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Accounts", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Account Log Definitions", + "operation": "Read Batch service log definitions", + "description": "Gets the available logs for the Batch service" + }, + "isDataAction": false, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "ServiceLog", + "displayName": "Service Logs", + "blobDuration": "PT1H" + } + ] + } + } + }, + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Account Metric Definitions", + "operation": "Read Batch service metric definitions", + "description": "Gets the available metrics for the Batch service" + }, + "isDataAction": false, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "CoreCount", + "displayName": "Dedicated Core Count", + "displayDescription": "Total number of dedicated cores in the batch account", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "TotalNodeCount", + "displayName": "Dedicated Node Count", + "displayDescription": "Total number of dedicated nodes in the batch account", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "LowPriorityCoreCount", + "displayName": "LowPriority Core Count", + "displayDescription": "Total number of low-priority cores in the batch account", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "TotalLowPriorityNodeCount", + "displayName": "Low-Priority Node Count", + "displayDescription": "Total number of low-priority nodes in the batch account", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "CreatingNodeCount", + "displayName": "Creating Node Count", + "displayDescription": "Number of nodes being created", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "StartingNodeCount", + "displayName": "Starting Node Count", + "displayDescription": "Number of nodes starting", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "WaitingForStartTaskNodeCount", + "displayName": "Waiting For Start Task Node Count", + "displayDescription": "Number of nodes waiting for the Start Task to complete", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "StartTaskFailedNodeCount", + "displayName": "Start Task Failed Node Count", + "displayDescription": "Number of nodes where the Start Task has failed", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "IdleNodeCount", + "displayName": "Idle Node Count", + "displayDescription": "Number of idle nodes", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "OfflineNodeCount", + "displayName": "Offline Node Count", + "displayDescription": "Number of offline nodes", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "RebootingNodeCount", + "displayName": "Rebooting Node Count", + "displayDescription": "Number of rebooting nodes", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "ReimagingNodeCount", + "displayName": "Reimaging Node Count", + "displayDescription": "Number of reimaging nodes", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "RunningNodeCount", + "displayName": "Running Node Count", + "displayDescription": "Number of running nodes", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "LeavingPoolNodeCount", + "displayName": "Leaving Pool Node Count", + "displayDescription": "Number of nodes leaving the Pool", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "UnusableNodeCount", + "displayName": "Unusable Node Count", + "displayDescription": "Number of unusable nodes", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "PreemptedNodeCount", + "displayName": "Preempted Node Count", + "displayDescription": "Number of preempted nodes", + "unit": "Count", + "aggregationType": "Total", + "lockAggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "TaskStartEvent", + "displayName": "Task Start Events", + "displayDescription": "Total number of tasks that have started", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "poolId", + "displayName": "Pool ID", + "toBeExportedForShoebox": true + }, + { + "name": "jobId", + "displayName": "Job ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "TaskCompleteEvent", + "displayName": "Task Complete Events", + "displayDescription": "Total number of tasks that have completed", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "poolId", + "displayName": "Pool ID", + "toBeExportedForShoebox": true + }, + { + "name": "jobId", + "displayName": "Job ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "TaskFailEvent", + "displayName": "Task Fail Events", + "displayDescription": "Total number of tasks that have completed in a failed state", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "poolId", + "displayName": "Pool ID", + "toBeExportedForShoebox": true + }, + { + "name": "jobId", + "displayName": "Job ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "PoolCreateEvent", + "displayName": "Pool Create Events", + "displayDescription": "Total number of pools that have been created", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "poolId", + "displayName": "Pool ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "PoolResizeStartEvent", + "displayName": "Pool Resize Start Events", + "displayDescription": "Total number of pool resizes that have started", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "poolId", + "displayName": "Pool ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "PoolResizeCompleteEvent", + "displayName": "Pool Resize Complete Events", + "displayDescription": "Total number of pool resizes that have completed", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "poolId", + "displayName": "Pool ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "PoolDeleteStartEvent", + "displayName": "Pool Delete Start Events", + "displayDescription": "Total number of pool deletes that have started", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "poolId", + "displayName": "Pool ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "PoolDeleteCompleteEvent", + "displayName": "Pool Delete Complete Events", + "displayDescription": "Total number of pool deletes that have completed", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "poolId", + "displayName": "Pool ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "JobDeleteCompleteEvent", + "displayName": "Job Delete Complete Events", + "displayDescription": "Total number of jobs that have been successfully deleted.", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "jobId", + "displayName": "Job ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "JobDeleteStartEvent", + "displayName": "Job Delete Start Events", + "displayDescription": "Total number of jobs that have been requested to be deleted.", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "jobId", + "displayName": "Job ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "JobDisableCompleteEvent", + "displayName": "Job Disable Complete Events", + "displayDescription": "Total number of jobs that have been successfully disabled.", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "jobId", + "displayName": "Job ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "JobDisableStartEvent", + "displayName": "Job Disable Start Events", + "displayDescription": "Total number of jobs that have been requested to be disabled.", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "jobId", + "displayName": "Job ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "JobStartEvent", + "displayName": "Job Start Events", + "displayDescription": "Total number of jobs that have been successfully started.", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "jobId", + "displayName": "Job ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "JobTerminateCompleteEvent", + "displayName": "Job Terminate Complete Events", + "displayDescription": "Total number of jobs that have been successfully terminated.", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "jobId", + "displayName": "Job ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + }, + { + "name": "JobTerminateStartEvent", + "displayName": "Job Terminate Start Events", + "displayDescription": "Total number of jobs that have been requested to be terminated.", + "unit": "Count", + "aggregationType": "Total", + "fillGapWithZero": false, + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "PT1H" + } + ], + "dimensions": [ + { + "name": "jobId", + "displayName": "Job ID", + "toBeExportedForShoebox": true + } + ], + "supportsInstanceLevelAggregation": false, + "enableRegionalMdmAccount": false + } + ] + } + } + }, + { + "name": "Microsoft.Batch/batchAccounts/jobs/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Jobs", + "operation": "List or Get Jobs", + "description": "Lists jobs on a Batch account or gets the properties of a job" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobs/write", + "display": { + "provider": "Microsoft Batch", + "resource": "Jobs", + "operation": "Create or Update Job", + "description": "Creates a new job on a Batch account or updates an existing job" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobs/delete", + "display": { + "provider": "Microsoft Batch", + "resource": "Jobs", + "operation": "Delete Job", + "description": "Deletes a job from a Batch account" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobSchedules/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Job Schedules", + "operation": "List or Get Job Schedules", + "description": "Lists job schedules on a Batch account or gets the properties of a job schedule" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobSchedules/write", + "display": { + "provider": "Microsoft Batch", + "resource": "Job Schedules", + "operation": "Create or Update Job Schedule", + "description": "Creates a new job schedule on a Batch account or updates an existing job schedule" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobSchedules/delete", + "display": { + "provider": "Microsoft Batch", + "resource": "Job Schedules", + "operation": "Delete Job Schedule", + "description": "Deletes a job schedule from a Batch account" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/operations/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Available Batch Operations", + "operation": "List Available Batch Operations", + "description": "Lists operations available on Microsoft.Batch resource provider" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Accounts", + "operation": "List or Get Batch Accounts", + "description": "Lists Batch accounts or gets the properties of a Batch account" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/write", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Accounts", + "operation": "Create or Update Batch Account", + "description": "Creates a new Batch account or updates an existing Batch account" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/delete", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Accounts", + "operation": "Delete Batch Account", + "description": "Deletes a Batch account" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/listkeys/action", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Accounts", + "operation": "List Batch Account Keys", + "description": "Lists access keys for a Batch account" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/regeneratekeys/action", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Accounts", + "operation": "Regenerate Batch Account Keys", + "description": "Regenerates access keys for a Batch account" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/locations/quotas/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Quotas", + "operation": "Get Batch Quotas", + "description": "Gets Batch quotas of the specified subscription at the specified Azure region" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/locations/checkNameAvailability/action", + "display": { + "provider": "Microsoft Batch", + "resource": "Name Availability", + "operation": "Check Name Availability", + "description": "Checks that the account name is valid and not in use." + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/operationResults/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider", + "operation": "Get Batch account operation results", + "description": "Gets the results of a long running Batch account operation" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/locations/accountOperationResults/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider", + "operation": "Get Batch account operation results", + "description": "Gets the results of a long running Batch account operation" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/register/action", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider", + "operation": "Register the Batch Resource Provider", + "description": "Registers the subscription for the Batch Resource Provider and enables the creation of Batch accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/unregister/action", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider", + "operation": "Unregister the Batch Resource Provider", + "description": "Unregisters the subscription for the Batch Resource Provider preventing the creation of Batch accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/syncAutoStorageKeys/action", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Accounts", + "operation": "Synchronize Auto Storage Account Keys", + "description": "Synchronizes access keys for the auto storage account configured for a Batch account" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Applications", + "operation": "List or Get Applications", + "description": "Lists applications or gets the properties of an application" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/write", + "display": { + "provider": "Microsoft Batch", + "resource": "Applications", + "operation": "Create or Update Application", + "description": "Creates a new application or updates an existing application" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/delete", + "display": { + "provider": "Microsoft Batch", + "resource": "Applications", + "operation": "Delete Application", + "description": "Deletes an application" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Application Packages", + "operation": "Get Application Package", + "description": "Gets the properties of an application package" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/write", + "display": { + "provider": "Microsoft Batch", + "resource": "Application Packages", + "operation": "Create or Update Application Package", + "description": "Creates a new application package or updates an existing application package" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/delete", + "display": { + "provider": "Microsoft Batch", + "resource": "Application Packages", + "operation": "Delete Application Package", + "description": "Deletes an application package" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/activate/action", + "display": { + "provider": "Microsoft Batch", + "resource": "Application Packages", + "operation": "Activate Application Package", + "description": "Activates an application package" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/certificates/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Certificates", + "operation": "List or Get Certificates", + "description": "Lists certificates on a Batch account or gets the properties of a certificate" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/certificates/write", + "display": { + "provider": "Microsoft Batch", + "resource": "Certificates", + "operation": "Create or Update Certificate", + "description": "Creates a new certificate on a Batch account or updates an existing certificate" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/certificates/delete", + "display": { + "provider": "Microsoft Batch", + "resource": "Certificates", + "operation": "Delete Certificate", + "description": "Deletes a certificate from a Batch account" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/certificates/cancelDelete/action", + "display": { + "provider": "Microsoft Batch", + "resource": "Certificates", + "operation": "Cancel Delete Certificate", + "description": "Cancels the failed deletion of a certificate on a Batch account" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/certificateOperationResults/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Certificates", + "operation": "Get Certificate Operation Results", + "description": "Gets the results of a long running certificate operation on a Batch account" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Pools", + "operation": "List or Get Pools", + "description": "Lists pools on a Batch account or gets the properties of a pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/write", + "display": { + "provider": "Microsoft Batch", + "resource": "Pools", + "operation": "Create or Update Pool", + "description": "Creates a new pool on a Batch account or updates an existing pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/delete", + "display": { + "provider": "Microsoft Batch", + "resource": "Pools", + "operation": "Delete Pool", + "description": "Deletes a pool from a Batch account" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/stopResize/action", + "display": { + "provider": "Microsoft Batch", + "resource": "Pools", + "operation": "Stop Pool Resize", + "description": "Stops an ongoing resize operation on a Batch account pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/disableAutoscale/action", + "display": { + "provider": "Microsoft Batch", + "resource": "Pools", + "operation": "Disable Pool AutoScale", + "description": "Disables automatic scaling for a Batch account pool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/poolOperationResults/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Pools", + "operation": "Get Pool Operation Results", + "description": "Gets the results of a long running pool operation on a Batch account" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/locations/virtualMachineSkus/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Supported Skus", + "operation": "List Supported Batch Virtual Machine VM", + "description": "Lists available Batch supported Virtual Machine VM sizes at the given location" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/locations/cloudServiceSkus/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Batch Supported Skus", + "operation": "List Supported Batch Cloud Service VM", + "description": "Lists available Batch supported Cloud Service VM sizes at the given location" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateLinkResources/read", + "display": { + "provider": "Microsoft Batch", + "resource": "PrivateLinkResources", + "operation": "Get or List Private link resources", + "description": "Gets the properties of a Private link resource or Lists Private link resources on a Batch account" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnections", + "operation": "Update Private endpoint connection", + "description": "Update an existing Private endpoint connection on a Batch account" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnections", + "operation": "Get or List Private endpoint connection", + "description": "Gets Private endpoint connection or Lists Private endpoint connections on a Batch account" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionResults/read", + "display": { + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnections", + "operation": "Get Batch account private endpoint connection operation results", + "description": "Gets the results of a long running Batch account private endpoint connection operation" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies", + "operation": "Validates a Private endpoint connection proxy", + "description": "Validates a Private endpoint connection proxy on a Batch account" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies", + "operation": "Create or Update Private endpoint connection proxy", + "description": "Create a new Private endpoint connection proxy on a Batch account" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies", + "operation": "Get Private endpoint connection proxy", + "description": "Gets Private endpoint connection proxy on a Batch account" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies", + "operation": "Delete Private endpoint connection proxy", + "description": "Delete a Private endpoint connection proxy on a Batch account" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxyResults/read", + "display": { + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies", + "operation": "Get Batch account private endpoint connection proxy operation results", + "description": "Gets the results of a long running Batch account private endpoint connection proxy operation" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/outboundNetworkDependenciesEndpoints/read", + "display": { + "provider": "Microsoft Batch", + "resource": "Outbound Network Dependencies Endpoints", + "operation": "List Outbound Network Dependency Endpoints", + "description": "Lists the outbound network dependency endpoints for a Batch account" + }, + "isDataAction": false, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_AcceleratedNetworking.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_AcceleratedNetworking.json new file mode 100644 index 000000000000..1cafd75991fa --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_AcceleratedNetworking.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D1_V2", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "enableAcceleratedNetworking": true + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8DB46CB72A227E2\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DB46CB72A227E2\"", + "properties": { + "lastModified": "2023-04-27T02:59:41.8592226Z", + "creationTime": "2023-04-27T02:59:41.8592226Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-04-27T02:59:41.8592226Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-04-27T03:00:34.0646502Z", + "vmSize": "STANDARD_D1_V2", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "dynamicVnetAssignmentScope": "none", + "enableAcceleratedNetworking": true + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-04-27T02:59:41.8592226Z" + }, + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "currentNodeCommunicationMode": "Classic" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_CloudServiceConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_CloudServiceConfiguration.json new file mode 100644 index 000000000000..3dac39cb1a92 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_CloudServiceConfiguration.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "displayName": "my-pool-name", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "taskSlotsPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "UserManaged", + "ipAddressIds": [ + "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135", + "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268" + ] + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "password": "", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "sshPrivateKey": "sshprivatekeyvalue", + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ] + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "taskSlotsPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "UserManaged", + "ipAddressIds": [ + "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135", + "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268" + ] + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ], + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json new file mode 100644 index 000000000000..1858cfa19d8b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 3, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json new file mode 100644 index 000000000000..599b7a26d4b8 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_NoPublicIPAddresses.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_NoPublicIPAddresses.json new file mode 100644 index 000000000000..7f1bb879997e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_NoPublicIPAddresses.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "NoPublicIPAddresses" + } + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "NoPublicIPAddresses" + } + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_PublicIPs.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_PublicIPs.json new file mode 100644 index 000000000000..a0e677c6724d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_PublicIPs.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "UserManaged", + "ipAddressIds": [ + "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135" + ] + } + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "UserManaged", + "ipAddressIds": [ + "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135" + ] + } + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_ResourceTags.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_ResourceTags.json new file mode 100644 index 000000000000..c6391bdcfed5 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_ResourceTags.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "Standard_d4s_v3", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "resourceTags": { + "TagName1": "TagValue1", + "TagName2": "TagValue2" + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8DB554F8E08BCF4\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DB554F8E08BCF4\"", + "properties": { + "lastModified": "2023-06-14T07:03:58.3231917Z", + "creationTime": "2023-06-14T07:03:58.3231917Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "vmSize": "STANDARD_D4S_V3", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-09-27T07:33:13.0625789Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "resourceTags": { + "TagName1": "TagValue1", + "TagName2": "TagValue2" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_SecurityProfile.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_SecurityProfile.json new file mode 100644 index 000000000000..d38491cc9880 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_SecurityProfile.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "Standard_d4s_v3", + "deploymentConfiguration": { + "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": null, + "vTpmEnabled": false + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8DB554F8E08BCF4\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DB554F8E08BCF4\"", + "properties": { + "lastModified": "2023-06-14T07:03:58.3231917Z", + "creationTime": "2023-06-14T07:03:58.3231917Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "vmSize": "STANDARD_D4S_V3", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "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": { + "vTpmEnabled": false + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-06-14T07:03:58.3231917Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_SharedImageGallery.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_SharedImageGallery.json new file mode 100644 index 000000000000..939b3c22533d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_SharedImageGallery.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_UserAssignedIdentities.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_UserAssignedIdentities.json new file mode 100644 index 000000000000..610fbd6ee28c --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_UserAssignedIdentities.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}, + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {} + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2020-10-01T10:22:55.9407275Z", + "creationTime": "2020-10-01T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2020-10-01T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2020-10-01T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "principalId1", + "clientId": "clientId1" + }, + "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "principalId": "principalId2", + "clientId": "clientId2" + } + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..d57bd1bfa59a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "licenseType": "Windows_Server", + "dataDisks": [ + { + "lun": 0, + "caching": "ReadWrite", + "diskSizeGB": 30, + "storageAccountType": "Premium_LRS" + }, + { + "lun": 1, + "caching": "None", + "diskSizeGB": 200, + "storageAccountType": "Standard_LRS" + } + ], + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk", + "TemporaryDisk" + ] + }, + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "osDisk": { + "ephemeralOSDiskSettings": { + "placement": "CacheDisk" + } + } + } + }, + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150, + "sourcePortRanges": [ + "1", + "2" + ] + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "licenseType": "Windows_Server", + "dataDisks": [ + { + "lun": 0, + "caching": "ReadWrite", + "diskSizeGB": 30, + "storageAccountType": "Premium_LRS" + }, + { + "lun": 1, + "caching": "None", + "diskSizeGB": 200, + "storageAccountType": "Standard_LRS" + } + ], + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk", + "TemporaryDisk" + ] + }, + "nodePlacementConfiguration": { + "policy": "Zonal" + } + } + }, + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150, + "sourcePortRanges": [ + "1", + "2" + ] + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json new file mode 100644 index 000000000000..8dde6e57bf13 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + }, + "deploymentConfiguration": { + "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" + } + } + ] + } + }, + "targetNodeCommunicationMode": "Default" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "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" + } + } + ] + } + }, + "targetNodeCommunicationMode": "Default" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json new file mode 100644 index 000000000000..3157a613bdee --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "Standard_d2s_v3", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "microsoftwindowsserver", + "offer": "windowsserver", + "sku": "2022-datacenter-smalldisk" + }, + "osDisk": { + "diskSizeGB": 100, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "caching": "ReadWrite", + "writeAcceleratorEnabled": false + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8DB51F14DC1A8AD\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DB51F396992B8D\"", + "properties": { + "lastModified": "2023-08-24T02:12:27.7527697Z", + "creationTime": "2023-08-24T02:12:27.7527697Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-08-24T02:12:27.7527697Z", + "vmSize": "STANDARD_D2_V3", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "microsoftwindowsserver", + "offer": "windowsserver", + "sku": "2022-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "diskSizeGB": 100, + "writeAcceleratorEnabled": false + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-08-24T02:12:27.7527697Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json new file mode 100644 index 000000000000..87da9b34bce2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "vmSize": "Standard_d4s_v3", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-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" + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8DB51F14DC1A8AD\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "mypool41", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DB51F396992B8D\"", + "properties": { + "lastModified": "2023-05-11T07:44:44.8580493Z", + "creationTime": "2023-05-11T07:44:44.8580493Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-05-11T07:44:44.8580493Z", + "vmSize": "STANDARD_D4S_V3", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-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" + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 2, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-05-11T07:44:44.8580493Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolDelete.json new file mode 100644 index 000000000000..97afe14ce4c3 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Retry-After": "15", + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/poolOperationResults/delete-testpool-8D4EDFF164A11C9?api-version=2022-01-01" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolDisableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolDisableAutoScale.json new file mode 100644 index 000000000000..3953da49f41c --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolDisableAutoScale.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet.json new file mode 100644 index 000000000000..699229ab5d74 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "taskSlotsPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150, + "sourcePortRanges": [ + "123", + "22" + ] + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ], + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_AcceleratedNetworking.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_AcceleratedNetworking.json new file mode 100644 index 000000000000..2faedae176a5 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_AcceleratedNetworking.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2023-04-28T02:32:32.8696419Z", + "creationTime": "2023-04-28T02:32:32.8696419Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-04-28T02:32:32.8696419Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-04-28T02:33:40.82831Z", + "vmSize": "STANDARD_D1_V2", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "networkConfiguration": { + "dynamicVnetAssignmentScope": "none", + "enableAcceleratedNetworking": true + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-04-28T02:32:32.8696419Z" + }, + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "currentNodeCommunicationMode": "Classic" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_SecurityProfile.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_SecurityProfile.json new file mode 100644 index 000000000000..bea270dba3e0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_SecurityProfile.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8DB554F8E08BCF4\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DB554F8E08BCF4\"", + "properties": { + "lastModified": "2023-06-14T07:03:58.3231917Z", + "creationTime": "2023-06-14T07:03:58.3231917Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-06-14T07:04:57.3413444Z", + "vmSize": "STANDARD_D4S_V3", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "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": { + "vTpmEnabled": false + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-06-14T07:03:58.3231917Z" + }, + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "currentNodeCommunicationMode": "Classic" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json new file mode 100644 index 000000000000..49488c34e0bf --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "taskSlotsPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M" + } + }, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "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" + } + } + ] + } + }, + "targetNodeCommunicationMode": "Default", + "currentNodeCommunicationMode": "Classic" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json new file mode 100644 index 000000000000..a911e751e962 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8DB51E64D3C3B69\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DB51E64D3C3B69\"", + "properties": { + "lastModified": "2023-08-24T02:12:27.7527697Z", + "creationTime": "2023-08-24T02:12:27.7527697Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-08-24T02:13:22.4881351Z", + "vmSize": "STANDARD_D2_V3", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "microsoftwindowsserver", + "offer": "windowsserver", + "sku": "2022-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "diskSizeGB": 100, + "writeAcceleratorEnabled": false + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-08-24T02:12:27.7527697Z" + }, + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "currentNodeCommunicationMode": "Classic" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json new file mode 100644 index 000000000000..7a9e76808cfc --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8DB51E64D3C3B69\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DB51E64D3C3B69\"", + "properties": { + "lastModified": "2023-05-11T07:44:44.8580493Z", + "creationTime": "2023-05-11T07:44:44.8580493Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-05-11T07:45:42.0881659Z", + "vmSize": "STANDARD_D4S_V3", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-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" + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 2, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-05-11T07:44:44.8580493Z" + }, + "currentDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "currentNodeCommunicationMode": "Classic" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolList.json new file mode 100644 index 000000000000..2c4c4add88af --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolList.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "taskSlotsPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150, + "sourcePortRanges": [ + "*" + ] + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ], + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "errors": [ + { + "code": "AllocationTimedout", + "message": "Desired number of dedicated nodes could not be allocated as the resize timeout was reached" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolListWithFilter.json new file mode 100644 index 000000000000..2146f508a367 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolListWithFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "$filter": "startswith(name, 'po') or (properties/allocationState eq 'Steady' and properties/provisioningStateTransitionTime lt datetime'2017-02-02')", + "$select": "properties/allocationState,properties/provisioningStateTransitionTime,properties/currentDedicatedNodes,properties/currentLowPriorityNodes", + "maxResults": "50" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 2 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/pooltest", + "name": "pooltest", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "provisioningStateTransitionTime": "2017-08-26T10:22:55.9407275Z", + "allocationState": "Resizing", + "currentDedicatedNodes": 4, + "currentLowPriorityNodes": 0 + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolStopResize.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolStopResize.json new file mode 100644 index 000000000000..73c2a0b8c49d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolStopResize.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT10M" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_EnableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_EnableAutoScale.json new file mode 100644 index 000000000000..90f1a717538e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_EnableAutoScale.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=34" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicated=34", + "evaluationInterval": "PT15M" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 34, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_OtherProperties.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_OtherProperties.json new file mode 100644 index 000000000000..c9c05b186fc2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_OtherProperties.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "metadata": [ + { + "name": "key1", + "value": "value1" + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234" + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678", + "version": "1.0" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY" + } + ], + "targetNodeCommunicationMode": "Simplified" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 8, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M" + }, + "metadata": [ + { + "name": "key1", + "value": "value1" + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234" + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678", + "version": "1.0" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "StartTask", + "Task", + "RemoteUser" + ] + } + ], + "targetNodeCommunicationMode": "Simplified" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_RemoveStartTask.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_RemoveStartTask.json new file mode 100644 index 000000000000..c4f294aeeb06 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_RemoveStartTask.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "startTask": {} + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicated=34", + "evaluationInterval": "PT15M" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 34, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_ResizePool.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_ResizePool.json new file mode 100644 index 000000000000..82a2b5e99f08 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PoolUpdate_ResizePool.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 8, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateBatchAccountCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateBatchAccountCreate.json new file mode 100644 index 000000000000..74f5cb6f77e6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateBatchAccountCreate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "keyVaultReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "publicNetworkAccess": "Disabled" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "UserSubscription", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "keyVaultReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "publicNetworkAccess": "Disabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateBatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateBatchAccountGet.json new file mode 100644 index 000000000000..cb391fb2cb1d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateBatchAccountGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2023-11-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "name": "testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + ] + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..435344ebc43a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateEndpointConnectionName": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "api-version": "2023-11-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0/accountOperationResults/sampleacct-30a022cb-a64f-4fd5-9289-8b38b342e9de?api-version=2023-11-01" + } + }, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..e18102b665e7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateEndpointConnectionName": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "name": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "groupIds": [ + "batchAccount" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..f807273e54c0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateEndpointConnectionName": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "api-version": "2023-11-01", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "name": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "groupIds": [ + "batchAccount" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + }, + "202": { + "headers": { + "Retry-After": "15", + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnectionProxyResults/Updating$testprivateEndpointConnection5.24d6b4b5$e65c-4330-bbe9-3a290d62f8e0-8D4EDFF164A11C9?api-version=2022-01-01" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionsList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..d5efbc4a028d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateEndpointConnectionName": "testprivateEndpointConnection", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection", + "name": "testprivateEndpointConnection", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "groupIds": [ + "batchAccount" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateLinkResourceGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateLinkResourceGet.json new file mode 100644 index 000000000000..73c2611bf4aa --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateLinkResourceGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateLinkResourceName": "batchAccount", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/batchAccount", + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts/privateLinkResources", + "properties": { + "groupId": "batchAccount", + "requiredMembers": [ + "batchAccount" + ], + "requiredZoneNames": [ + "privatelink.japaneast.batch.azure.com" + ] + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateLinkResourcesList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..03a97fa555d3 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-11-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/batchAccount", + "name": "batchAccount", + "type": "Microsoft.Batch/batchAccounts/privateLinkResources", + "properties": { + "groupId": "batchAccount", + "requiredMembers": [ + "batchAccount" + ], + "requiredZoneNames": [ + "privatelink.japaneast.batch.azure.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/readme.md b/specification/batch/resource-manager/readme.md index 03ab6f559ef5..0daa35736365 100644 --- a/specification/batch/resource-manager/readme.md +++ b/specification/batch/resource-manager/readme.md @@ -28,18 +28,27 @@ These are the global settings for the Batch API. title: BatchManagementClient description: Batch Client openapi-type: arm -tag: package-2023-05 +tag: package-2023-11 ``` +### Tag: package-2023-11 + +These settings apply only when `--tag=package-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-2023-11' +input-file: + - Microsoft.Batch/stable/2023-11-01/BatchManagement.json +``` ### Tag: package-2023-05 These settings apply only when `--tag=package-2023-05` is specified on the command line. -```yaml $(tag) == 'package-2023-05' +``` yaml $(tag) == 'package-2023-05' input-file: - Microsoft.Batch/stable/2023-05-01/BatchManagement.json ``` + ### Tag: package-2022-10 These settings apply only when `--tag=package-2022-10` is specified on the command line. diff --git a/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetCodeSigningStatus.json b/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetCodeSigningStatus.json deleted file mode 100644 index 575d9f8e835d..000000000000 --- a/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetCodeSigningStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "CertificateProfileOperations_GetCodeSigningStatus", - "title": "Gets the status of a codesign operation.", - "parameters": { - "codeSigningAccountName": "YourAccountName", - "certificateProfileName": "YourCertificateProfileName", - "api-version": "2023-06-15-preview", - "operationId": "9797c668-5b3c-4586-8e0c-2768c8160bad" - }, - "responses": { - "200": { - "body": { - "id": "76f60a30-d088-42e0-b16d-b76b88d3cbe1", - "status": "InProgress", - "signStatus": { - "operationId": "76f60a30-d088-42e0-b16d-b76b88d3cbe1", - "status": "InProgress", - "signature": "OWY4NmQwODE4ODRjN2Q2NTlhMmZlYWEwYzU1YWQwMTVhM2JmNGYxYjJiMGI4MjJjZDE1ZDZjMTViMGYwMGEwOA==", - "signingCertificate": "N2IzZDk3OWNhODMzMGE5NGZhN2U5ZTFiNDY2ZDhiOTllMGJjZGVhMWVjOTA1OTZjMGRjYzhkN2VmNmI0MzAwYw==" - } - } - } - } -} diff --git a/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSignRootCertificate.json b/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSignRootCertificate.json deleted file mode 100644 index a30586b44a55..000000000000 --- a/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_GetSignRootCertificate.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "CertificateProfileOperations_GetSignRootCertificate", - "title": "Gets the codesigning root certificate on the certificate chain for that account and profile name.", - "parameters": { - "codeSigningAccountName": "YourAccountName", - "certificateProfileName": "YourCertificateProfileName", - "api-version": "2023-06-15-preview" - }, - "responses": { - "200": { - "body": "MjUzNjlhMDQ3Yzc0YTQ3NjdiNjYzZTIzMWFlMTAxMDVkODMxM2Y5ZjNkNmU0YTVlOTQ1ZGZiMWQ5NDgzOWU0NQ==" - } - } -} diff --git a/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_ListSignEkus.json b/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_ListSignEkus.json deleted file mode 100644 index f02e52c98d6e..000000000000 --- a/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_ListSignEkus.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "operationId": "CertificateProfileOperations_ListSignEkus", - "title": "Gets a list of extended key usage object identifiers that are allowed.", - "parameters": { - "codeSigningAccountName": "YourAccountName", - "certificateProfileName": "YourCertificateProfileName", - "api-version": "2023-06-15-preview" - }, - "responses": { - "200": { - "body": { - "ekus": [ - "1.3.6.1.5.5.7.3.8", - "1.3.6.1.5.5.7.3.10" - ] - } - } - } -} diff --git a/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_Sign.json b/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_Sign.json deleted file mode 100644 index 1d8643356d05..000000000000 --- a/specification/codesigning/CodeSigning/examples/2023-06-15-preview/CertificateProfileOperations_Sign.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "operationId": "CertificateProfileOperations_Sign", - "title": "Submit a codesign operation.", - "parameters": { - "codeSigningAccountName": "YourAccountName", - "certificateProfileName": "YourCertificateProfileName", - "api-version": "2023-06-15-preview", - "x-correlation-id": "9797c668-5b3c-4586-8e0c-2768c8160bad", - "body": { - "signatureAlgorithm": "RS256", - "digest": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=", - "fileHashList": [ - "Y29uc2VjdGV0dXIgYWRpcGlzY2luZyBlbGl0", - "c2VkIGRvIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1bnQ=" - ], - "authenticodeHashList": [ - "dXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBhbGlxdWE=", - "IFV0IGVuaW0gYWQgbWluaW0gdmVuaWFt" - ] - } - }, - "responses": { - "202": { - "headers": { - "azure-async-operation": "http://localhost:8080/operations/76f60a30-d088-42e0-b16d-b76b88d3cbe1" - }, - "body": { - "id": "76f60a30-d088-42e0-b16d-b76b88d3cbe1", - "status": "InProgress", - "signStatus": { - "operationId": "76f60a30-d088-42e0-b16d-b76b88d3cbe1", - "status": "InProgress", - "signature": "cXVpcyBub3N0cnVkIGV4ZXJjaXRhdGlvbiB1bGxhbWNvIGxhYm9yaXM=", - "signingCertificate": "bmlzaSB1dCBhbGlxdWlwIGV4IGVhIGNvbW1vZG8gY29uc2VxdWF0" - } - } - } - } -} diff --git a/specification/codesigning/CodeSigning/main.tsp b/specification/codesigning/CodeSigning/main.tsp deleted file mode 100644 index 5de3acc20400..000000000000 --- a/specification/codesigning/CodeSigning/main.tsp +++ /dev/null @@ -1,197 +0,0 @@ -import "@typespec/rest"; -import "@typespec/versioning"; -import "@azure-tools/typespec-azure-core"; - -using TypeSpec.Http; -using TypeSpec.Rest; -using TypeSpec.Versioning; -using Azure.Core; - -@useAuth( - OAuth2Auth<[ - { - type: OAuth2FlowType.implicit, - authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", - scopes: ["https://codesigning.azure.net/.default"], - } - ]> -) -@service({ - title: "Azure CodeSigning", - summary: "Azure CodeSigning is a service that provides managed code signing for all.", -}) -@versioned(Azure.CodeSigning.Versions) -@server( - "https://{region}.codesigning.azure.net/", - "CodeSign and retrieve relevant information pertaining signing process.", - { - @doc("The Azure region wherein requests for signing will be sent.") - region: string, - } -) -@doc("Azure CodeSigning is a service that provides managed code signing for all.") -namespace Azure.CodeSigning; - -@doc("Versions info.") -enum Versions { - @doc("The 2023-06-15-preview version.") - @useDependency(Azure.Core.Versions.v1_0_Preview_2) - v2023_06_15_preview: "2023-06-15-preview", -} - -interface CertificateProfileOperations { - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "This is a custom operation status endpoint." - @summary("Gets the status of a codesigning operation.") - @doc("This status operation requires that a Sign request has been submitted and the operationId is known.") - @route("/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}/sign/{operationId}") - getCodeSigningStatus is Foundations.GetOperationStatus< - CodeSigningOptions, - CodeSignResult - >; - - #suppress "@azure-tools/typespec-azure-core/rpc-operation-request-body" "no body included, bytesbody is the response object." - #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service needs rpc paths to follow pattern of other services." - @summary("Gets the codesigning root certificate on the certificate chain for that account and profile name.") - @doc("The root certificate is generated as part of the initial account creation and it is used to sign the bits for the profile provided.") - @route("/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}/sign/rootcert") - getSignRootCertificate is RpcOperation< - CodeSigningOptions, - BytesBody<"application/x-x509-ca-cert"> - >; - - @summary("Gets a list of extended key usage object identifiers that are allowed for this account and profile combination.") - @doc("The list of extended key usages are used to determine the purpose of the certificate usage as part of the codesigning operation.") - listSignEkus is StandardResourceOperations.ResourceList; - - @summary("Submit a codesign operation.") - @doc("Submit a codesign operation under the created codesign account and profile name provided.") - @pollingOperation(CertificateProfileOperations.getCodeSigningStatus) - sign is StandardResourceOperations.LongRunningResourceAction< - CertificateProfile, - CodeSigningSubmissionOptions, - CodeSignOperationStatus - >; -} - -@doc("Algorithms supported for signing.") -enum SignatureAlgorithm { - @doc("RSASSA-PKCS1-v1_5 using SHA-256 hash algorithm.") - RS256, - - @doc("RSASSA-PKCS1-v1_5 using SHA-384 hash algorithm.") - RS384, - - @doc("RSASSA-PKCS1-v1_5 using SHA-512 hash algorithm.") - RS512, - - @doc("RSASSA-PSS using SHA-256 hash algorithm.") - PS256, - - @doc("RSASSA-PSS using SHA-384 hash algorithm.") - PS384, - - @doc("RSASSA-PSS using SHA-512 hash algorithm.") - PS512, - - @doc("ECDSA using P-256 and SHA-256 hash algorithm.") - ES256, - - @doc("ECDSA using P-384 and SHA-384 hash algorithm.") - ES384, - - @doc("ECDSA using P-521 and SHA-512 hash algorithm.") - ES512, - - @doc("ECDSA using secp256k1 and SHA-256 hash algorithm.") - ES256K, -} - -@doc("Azure CodeSigning customer account created upon registration on the service.") -@resource("codesigningaccounts") -model CodeSigningAccount { - @key("codeSigningAccountName") - @visibility("read", "update") - @doc("Azure CodeSigning account name.") - codeSigningAccountName: string; -} - -@doc("Azure CodeSigning certificate profile configured on a codesign account.") -@resource("certificateprofiles") -@parentResource(CodeSigningAccount) -model CertificateProfile { - @key("certificateProfileName") - @visibility("read", "update") - @doc("Azure Codesigning certificate profile name under a codesign account.") - certificateProfileName: string; -} - -@doc("The codesign request information to be signed by the service.") -model CodeSigningSubmissionOptions { - @doc("The supported signature algorithm identifiers.") - signatureAlgorithm: SignatureAlgorithm; - - @doc("Content digest to codesign.") - digest: bytes; - - @doc("List of full file digital signatures.") - fileHashList?: bytes[]; - - @doc("List of authenticode digital signatures.") - authenticodeHashList?: bytes[]; -} - -@doc("The codesign operation status response.") -model CodeSignOperationStatus { - @doc("Unique Id of the operation.") - id: string; - - @doc("The result of the codesign operation including the signature and signing certificate.") - signResult?: CodeSignResult; -} - -@doc("The sign status model.") -model CodeSignResult { - @doc("Response Id of the codesign operation.") - operationId: string; - - @doc("Digital signature of the requested content digest.") - signature?: bytes; - - @doc(""" -Signing certificate corresponding to the private key used to codesign the requested -digest. -""") - signingCertificate?: bytes; -} - -@doc("Codesigning option parameters corresponding to the account and certificate profile name.") -model CodeSigningOptions { - @doc("CodeSigning account name.") - @path - codeSigningAccountName: string; - - @doc("Certificate profile name.") - @path - certificateProfileName: string; -} - -@doc("Extended key usage object identifier that are allowed.") -@resource("sign/eku") -@parentResource(CertificateProfile) -model ExtendedKeyUsage { - @key("ekus") - @visibility("read", "update") - @doc("An element of ekus.") - ekus: string[]; -} - -@doc("Public root certificate from the certificate chain.") -model BytesBody { - @doc("The root certificate of the certificate chain of this profile.") - @body - body: bytes; - - @doc("The content type of the x509 cert.") - @header - contentType: ContentType; -} diff --git a/specification/codesigning/CodeSigning/tspconfig.yaml b/specification/codesigning/CodeSigning/tspconfig.yaml deleted file mode 100644 index 9c9521757e51..000000000000 --- a/specification/codesigning/CodeSigning/tspconfig.yaml +++ /dev/null @@ -1,32 +0,0 @@ -parameters: - "service-dir": - default: "sdk/codesigning" -emit: - - "@azure-tools/typespec-autorest" -linter: - extends: - - "@azure-tools/typespec-azure-core/all" -options: - "@azure-tools/typespec-autorest": - azure-resource-provider-folder: "data-plane" - emitter-output-dir: "{project-root}/.." - examples-directory: "examples" - output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azure.codesigning.json" - "@azure-tools/typespec-python": - package-dir: "azure-codesigning" - package-name: "{package-dir}" - "@azure-tools/typespec-csharp": - clear-output-folder: true - package-dir: "Azure.CodeSigning" - model-namespace: false - namespace: "{package-dir}" - "@azure-tools/typespec-ts": - package-dir: "azurecodesigning-rest" - generateMetadata: true - generateTest: true - packageDetails: - name: "@azure-rest/azure-codesigning-rest" - description: "Azure Codesigning Service" - "@azure-tools/typespec-java": - package-dir: "azure-codesigning" - namespace: com.azure.codesigning diff --git a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json b/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json deleted file mode 100644 index 4be8817cbfee..000000000000 --- a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json +++ /dev/null @@ -1,693 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure CodeSigning", - "version": "2023-06-15-preview", - "description": "Azure CodeSigning is a service that provides managed code signing for all.", - "x-typespec-generated": [ - { - "emitter": "@azure-tools/typespec-autorest" - } - ] - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "https://{region}.codesigning.azure.net/", - "useSchemePrefix": false, - "parameters": [ - { - "name": "region", - "in": "path", - "description": "The Azure region wherein requests for signing will be sent.", - "required": true, - "type": "string" - } - ] - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ], - "security": [ - { - "OAuth2Auth": [ - "https://codesigning.azure.net/.default" - ] - } - ], - "securityDefinitions": { - "OAuth2Auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", - "scopes": { - "https://codesigning.azure.net/.default": "" - } - } - }, - "tags": [], - "paths": { - "/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}:sign": { - "post": { - "operationId": "CertificateProfileOperations_Sign", - "summary": "Submit a codesign operation.", - "description": "Submit a codesign operation under the created codesign account and profile name provided.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "codeSigningAccountName", - "in": "path", - "description": "Azure CodeSigning account name.", - "required": true, - "type": "string" - }, - { - "name": "certificateProfileName", - "in": "path", - "description": "Azure Codesigning certificate profile name under a codesign account.", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CodeSigningSubmissionOptions" - } - } - ], - "responses": { - "202": { - "description": "The request has been accepted for processing, but processing has not yet completed.", - "schema": { - "type": "object", - "description": "Provides status details for long running operations.", - "properties": { - "id": { - "type": "string", - "description": "The unique ID of the operation." - }, - "status": { - "$ref": "#/definitions/Azure.Core.Foundations.OperationState", - "description": "The status of the operation" - }, - "error": { - "$ref": "#/definitions/Azure.Core.Foundations.Error", - "description": "Error object that describes the error when status is \"Failed\"." - }, - "result": { - "$ref": "#/definitions/CodeSignOperationStatus", - "description": "The result of the operation." - } - }, - "required": [ - "id", - "status" - ] - }, - "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": { - "Submit a codesign operation.": { - "$ref": "./examples/CertificateProfileOperations_Sign.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}/sign/{operationId}": { - "get": { - "operationId": "CertificateProfileOperations_GetCodeSigningStatus", - "summary": "Gets the status of a codesigning operation.", - "description": "This status operation requires that a Sign request has been submitted and the operationId is known.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/CodeSigningOptions.codeSigningAccountName" - }, - { - "$ref": "#/parameters/CodeSigningOptions.certificateProfileName" - }, - { - "name": "operationId", - "in": "path", - "description": "The unique ID of the operation.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "type": "object", - "description": "Provides status details for long running operations.", - "properties": { - "id": { - "type": "string", - "description": "The unique ID of the operation." - }, - "status": { - "$ref": "#/definitions/Azure.Core.Foundations.OperationState", - "description": "The status of the operation" - }, - "error": { - "$ref": "#/definitions/Azure.Core.Foundations.Error", - "description": "Error object that describes the error when status is \"Failed\"." - }, - "result": { - "$ref": "#/definitions/CodeSignResult", - "description": "The result of the operation." - } - }, - "required": [ - "id", - "status" - ] - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" - }, - "headers": { - "x-ms-error-code": { - "type": "string", - "description": "String error code indicating what went wrong." - } - } - } - }, - "x-ms-examples": { - "Gets the status of a codesign operation.": { - "$ref": "./examples/CertificateProfileOperations_GetCodeSigningStatus.json" - } - } - } - }, - "/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}/sign/eku": { - "get": { - "operationId": "CertificateProfileOperations_ListSignEkus", - "summary": "Gets a list of extended key usage object identifiers that are allowed for this account and profile combination.", - "description": "The list of extended key usages are used to determine the purpose of the certificate usage as part of the codesigning operation.", - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "name": "codeSigningAccountName", - "in": "path", - "description": "Azure CodeSigning account name.", - "required": true, - "type": "string" - }, - { - "name": "certificateProfileName", - "in": "path", - "description": "Azure Codesigning certificate profile name under a codesign account.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The request has succeeded.", - "schema": { - "$ref": "#/definitions/PagedExtendedKeyUsage" - } - }, - "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 a list of extended key usage object identifiers that are allowed.": { - "$ref": "./examples/CertificateProfileOperations_ListSignEkus.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/codesigningaccounts/{codeSigningAccountName}/certificateprofiles/{certificateProfileName}/sign/rootcert": { - "get": { - "operationId": "CertificateProfileOperations_GetSignRootCertificate", - "summary": "Gets the codesigning root certificate on the certificate chain for that account and profile name.", - "description": "The root certificate is generated as part of the initial account creation and it is used to sign the bits for the profile provided.", - "produces": [ - "application/x-x509-ca-cert", - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" - }, - { - "$ref": "#/parameters/CodeSigningOptions.codeSigningAccountName" - }, - { - "$ref": "#/parameters/CodeSigningOptions.certificateProfileName" - } - ], - "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": { - "Gets the codesigning root certificate on the certificate chain for that account and profile name.": { - "$ref": "./examples/CertificateProfileOperations_GetSignRootCertificate.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." - } - } - }, - "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." - } - ] - } - }, - "CertificateProfile": { - "type": "object", - "description": "Azure CodeSigning certificate profile configured on a codesign account.", - "properties": { - "certificateProfileName": { - "type": "string", - "description": "Azure Codesigning certificate profile name under a codesign account.", - "x-ms-mutability": [ - "read", - "update" - ] - } - }, - "required": [ - "certificateProfileName" - ] - }, - "CodeSignOperationStatus": { - "type": "object", - "description": "The codesign operation status response.", - "properties": { - "id": { - "type": "string", - "description": "Unique Id of the operation." - }, - "signResult": { - "$ref": "#/definitions/CodeSignResult", - "description": "The result of the codesign operation including the signature and signing certificate." - } - }, - "required": [ - "id" - ] - }, - "CodeSignResult": { - "type": "object", - "description": "The sign status model.", - "properties": { - "operationId": { - "type": "string", - "description": "Response Id of the codesign operation." - }, - "signature": { - "type": "string", - "format": "byte", - "description": "Digital signature of the requested content digest." - }, - "signingCertificate": { - "type": "string", - "format": "byte", - "description": "Signing certificate corresponding to the private key used to codesign the requested\ndigest." - } - }, - "required": [ - "operationId" - ] - }, - "CodeSigningAccount": { - "type": "object", - "description": "Azure CodeSigning customer account created upon registration on the service.", - "properties": { - "codeSigningAccountName": { - "type": "string", - "description": "Azure CodeSigning account name.", - "x-ms-mutability": [ - "read", - "update" - ] - } - }, - "required": [ - "codeSigningAccountName" - ] - }, - "CodeSigningSubmissionOptions": { - "type": "object", - "description": "The codesign request information to be signed by the service.", - "properties": { - "signatureAlgorithm": { - "$ref": "#/definitions/SignatureAlgorithm", - "description": "The supported signature algorithm identifiers." - }, - "digest": { - "type": "string", - "format": "byte", - "description": "Content digest to codesign." - }, - "fileHashList": { - "type": "array", - "description": "List of full file digital signatures.", - "items": { - "type": "string", - "format": "byte" - } - }, - "authenticodeHashList": { - "type": "array", - "description": "List of authenticode digital signatures.", - "items": { - "type": "string", - "format": "byte" - } - } - }, - "required": [ - "signatureAlgorithm", - "digest" - ] - }, - "ExtendedKeyUsage": { - "type": "object", - "description": "Extended key usage object identifier that are allowed.", - "properties": { - "ekus": { - "type": "array", - "description": "An element of ekus.", - "items": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "update" - ] - } - }, - "required": [ - "ekus" - ] - }, - "PagedExtendedKeyUsage": { - "type": "object", - "description": "Paged collection of ExtendedKeyUsage items", - "properties": { - "value": { - "type": "array", - "description": "The ExtendedKeyUsage items on this page", - "items": { - "$ref": "#/definitions/ExtendedKeyUsage" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items" - } - }, - "required": [ - "value" - ] - }, - "SignatureAlgorithm": { - "type": "string", - "description": "Algorithms supported for signing.", - "enum": [ - "RS256", - "RS384", - "RS512", - "PS256", - "PS384", - "PS512", - "ES256", - "ES384", - "ES512", - "ES256K" - ], - "x-ms-enum": { - "name": "SignatureAlgorithm", - "modelAsString": true, - "values": [ - { - "name": "RS256", - "value": "RS256", - "description": "RSASSA-PKCS1-v1_5 using SHA-256 hash algorithm." - }, - { - "name": "RS384", - "value": "RS384", - "description": "RSASSA-PKCS1-v1_5 using SHA-384 hash algorithm." - }, - { - "name": "RS512", - "value": "RS512", - "description": "RSASSA-PKCS1-v1_5 using SHA-512 hash algorithm." - }, - { - "name": "PS256", - "value": "PS256", - "description": "RSASSA-PSS using SHA-256 hash algorithm." - }, - { - "name": "PS384", - "value": "PS384", - "description": "RSASSA-PSS using SHA-384 hash algorithm." - }, - { - "name": "PS512", - "value": "PS512", - "description": "RSASSA-PSS using SHA-512 hash algorithm." - }, - { - "name": "ES256", - "value": "ES256", - "description": "ECDSA using P-256 and SHA-256 hash algorithm." - }, - { - "name": "ES384", - "value": "ES384", - "description": "ECDSA using P-384 and SHA-384 hash algorithm." - }, - { - "name": "ES512", - "value": "ES512", - "description": "ECDSA using P-521 and SHA-512 hash algorithm." - }, - { - "name": "ES256K", - "value": "ES256K", - "description": "ECDSA using secp256k1 and SHA-256 hash algorithm." - } - ] - } - }, - "Versions": { - "type": "string", - "description": "Versions info.", - "enum": [ - "2023-06-15-preview" - ], - "x-ms-enum": { - "name": "Versions", - "modelAsString": true, - "values": [ - { - "name": "v2023_06_15_preview", - "value": "2023-06-15-preview", - "description": "The 2023-06-15-preview version." - } - ] - } - } - }, - "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" - }, - "CodeSigningOptions.certificateProfileName": { - "name": "certificateProfileName", - "in": "path", - "description": "Certificate profile name.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "CodeSigningOptions.codeSigningAccountName": { - "name": "codeSigningAccountName", - "in": "path", - "description": "CodeSigning account name.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetCodeSigningStatus.json b/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetCodeSigningStatus.json deleted file mode 100644 index 575d9f8e835d..000000000000 --- a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetCodeSigningStatus.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "CertificateProfileOperations_GetCodeSigningStatus", - "title": "Gets the status of a codesign operation.", - "parameters": { - "codeSigningAccountName": "YourAccountName", - "certificateProfileName": "YourCertificateProfileName", - "api-version": "2023-06-15-preview", - "operationId": "9797c668-5b3c-4586-8e0c-2768c8160bad" - }, - "responses": { - "200": { - "body": { - "id": "76f60a30-d088-42e0-b16d-b76b88d3cbe1", - "status": "InProgress", - "signStatus": { - "operationId": "76f60a30-d088-42e0-b16d-b76b88d3cbe1", - "status": "InProgress", - "signature": "OWY4NmQwODE4ODRjN2Q2NTlhMmZlYWEwYzU1YWQwMTVhM2JmNGYxYjJiMGI4MjJjZDE1ZDZjMTViMGYwMGEwOA==", - "signingCertificate": "N2IzZDk3OWNhODMzMGE5NGZhN2U5ZTFiNDY2ZDhiOTllMGJjZGVhMWVjOTA1OTZjMGRjYzhkN2VmNmI0MzAwYw==" - } - } - } - } -} diff --git a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSignRootCertificate.json b/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSignRootCertificate.json deleted file mode 100644 index a30586b44a55..000000000000 --- a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_GetSignRootCertificate.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "operationId": "CertificateProfileOperations_GetSignRootCertificate", - "title": "Gets the codesigning root certificate on the certificate chain for that account and profile name.", - "parameters": { - "codeSigningAccountName": "YourAccountName", - "certificateProfileName": "YourCertificateProfileName", - "api-version": "2023-06-15-preview" - }, - "responses": { - "200": { - "body": "MjUzNjlhMDQ3Yzc0YTQ3NjdiNjYzZTIzMWFlMTAxMDVkODMxM2Y5ZjNkNmU0YTVlOTQ1ZGZiMWQ5NDgzOWU0NQ==" - } - } -} diff --git a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_ListSignEkus.json b/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_ListSignEkus.json deleted file mode 100644 index f02e52c98d6e..000000000000 --- a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_ListSignEkus.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "operationId": "CertificateProfileOperations_ListSignEkus", - "title": "Gets a list of extended key usage object identifiers that are allowed.", - "parameters": { - "codeSigningAccountName": "YourAccountName", - "certificateProfileName": "YourCertificateProfileName", - "api-version": "2023-06-15-preview" - }, - "responses": { - "200": { - "body": { - "ekus": [ - "1.3.6.1.5.5.7.3.8", - "1.3.6.1.5.5.7.3.10" - ] - } - } - } -} diff --git a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_Sign.json b/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_Sign.json deleted file mode 100644 index 1d8643356d05..000000000000 --- a/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_Sign.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "operationId": "CertificateProfileOperations_Sign", - "title": "Submit a codesign operation.", - "parameters": { - "codeSigningAccountName": "YourAccountName", - "certificateProfileName": "YourCertificateProfileName", - "api-version": "2023-06-15-preview", - "x-correlation-id": "9797c668-5b3c-4586-8e0c-2768c8160bad", - "body": { - "signatureAlgorithm": "RS256", - "digest": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=", - "fileHashList": [ - "Y29uc2VjdGV0dXIgYWRpcGlzY2luZyBlbGl0", - "c2VkIGRvIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1bnQ=" - ], - "authenticodeHashList": [ - "dXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBhbGlxdWE=", - "IFV0IGVuaW0gYWQgbWluaW0gdmVuaWFt" - ] - } - }, - "responses": { - "202": { - "headers": { - "azure-async-operation": "http://localhost:8080/operations/76f60a30-d088-42e0-b16d-b76b88d3cbe1" - }, - "body": { - "id": "76f60a30-d088-42e0-b16d-b76b88d3cbe1", - "status": "InProgress", - "signStatus": { - "operationId": "76f60a30-d088-42e0-b16d-b76b88d3cbe1", - "status": "InProgress", - "signature": "cXVpcyBub3N0cnVkIGV4ZXJjaXRhdGlvbiB1bGxhbWNvIGxhYm9yaXM=", - "signingCertificate": "bmlzaSB1dCBhbGlxdWlwIGV4IGVhIGNvbW1vZG8gY29uc2VxdWF0" - } - } - } - } -} diff --git a/specification/codesigning/data-plane/readme.md b/specification/codesigning/data-plane/readme.md deleted file mode 100644 index 1a43e8691a4b..000000000000 --- a/specification/codesigning/data-plane/readme.md +++ /dev/null @@ -1,41 +0,0 @@ -# Azure.CodeSigning - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Azure.CodeSigning. - -## Getting Started - -To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: - -> `autorest readme.md` - -To see additional help and options, run: - -> `autorest --help` - -For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. - ---- - -## Configuration - -### Basic Information - -These are the global settings for the Azure.CodeSigning. - -```yaml -openapi-type: data-plane -tag: 2023-06-15-preview -``` - -### Tag: 2023-06-15-preview - -These settings apply only when `--tag=2023-06-15-preview` is specified on the command line. - -```yaml $(tag) == '2023-06-15-preview' -input-file: - - Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json -``` - ---- diff --git a/specification/cognitiveservices/ContentSafety/tspconfig.yaml b/specification/cognitiveservices/ContentSafety/tspconfig.yaml index 43f100e93aa8..c8e89235fa90 100644 --- a/specification/cognitiveservices/ContentSafety/tspconfig.yaml +++ b/specification/cognitiveservices/ContentSafety/tspconfig.yaml @@ -16,6 +16,7 @@ options: package-dir: "azure-ai-contentsafety" package-version: "1.0.0" package-name: "{package-dir}" + package-pprint-name: "\"Azure AI Content Safety\"" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.ContentSafety" namespace: "{package-dir}" @@ -31,3 +32,4 @@ options: package-dir: "azure-ai-contentsafety" namespace: com.azure.ai.contentsafety examples-directory: examples + partial-update: true diff --git a/specification/cognitiveservices/OpenAI.Inference/client.tsp b/specification/cognitiveservices/OpenAI.Inference/client.tsp index 723a60c3a104..1674b4aad019 100644 --- a/specification/cognitiveservices/OpenAI.Inference/client.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/client.tsp @@ -1,46 +1,43 @@ import "@azure-tools/typespec-client-generator-core"; + +import "./client/custom_visibility.tsp"; import "./main.tsp"; using Azure.ClientGenerator.Core; -// Azure-specific long-running operations should be treated as implementation details that are wrapped into -// appropriately merged public surface. -@@access(Azure.OpenAI.beginAzureBatchImageGeneration, Access.internal); -@@access(Azure.OpenAI.getAzureBatchImageGenerationOperationStatus, - Access.internal -); - -// Azure-specific Chat Completions with extensions should be handled by clients as a conditional selection within the -// shared Chat Completions route, with the selection gated by the presence or non-presence of additional child -// configuration options on the request payload options model. -@@access(Azure.OpenAI.getChatCompletionsWithAzureExtensions, Access.internal); - -// Some models from routes with suppressed visibility are still desired for custom public surface. -@@access(Azure.OpenAI.ImageGenerationOptions, Access.public); -@@usage(Azure.OpenAI.ImageGenerationOptions, Usage.input | Usage.output); -@@access(Azure.OpenAI.ImageLocation, Access.public); -@@usage(Azure.OpenAI.ImageLocation, Usage.input | Usage.output); -@@access(Azure.OpenAI.ImageSize, Access.public); -@@usage(Azure.OpenAI.ImageGenerations, Usage.input | Usage.output); - -// Java will need to have those models expose in public surface. -@@access(Azure.OpenAI.AudioTranscription, Access.public, "java"); -@@access(Azure.OpenAI.AudioTranscriptionOptions, Access.public, "java"); -@@access(Azure.OpenAI.AudioTranslation, Access.public, "java"); -@@access(Azure.OpenAI.AudioTranslationOptions, Access.public, "java"); -@@access(Azure.OpenAI.AzureOpenAIOperationState, Access.public, "java"); - -@@access(Azure.OpenAI.AzureCognitiveSearchIndexFieldMappingOptions, - Access.public -); -@@usage(Azure.OpenAI.AzureCognitiveSearchIndexFieldMappingOptions, Usage.input); - -@@access(Azure.OpenAI.AzureCognitiveSearchQueryType, Access.public); -@@usage(Azure.OpenAI.AzureCognitiveSearchQueryType, Usage.input); - -@@access(Azure.OpenAI.AzureCognitiveSearchChatExtensionConfiguration, - Access.public -); -@@usage(Azure.OpenAI.AzureCognitiveSearchChatExtensionConfiguration, - Usage.input -); +#suppress "@azure-tools/typespec-azure-core/casing-style" "OpenAI is a case-sensitive name" +@TypeSpec.Versioning.useDependency( + Azure.OpenAI.ServiceApiVersions.v2023_12_01_Preview +) +namespace Client; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "OpenAI is a case-sensitive name" +@client({ + name: "OpenAIClient", + service: Azure.OpenAI, +}) +interface OpenAIClient { + #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "non-model response value needed" + getAudioTranscriptionAsPlainText is Azure.OpenAI.getAudioTranscriptionAsPlainText; + + #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "non-model response value needed" + getAudioTranscriptionAsResponseObject is Azure.OpenAI.getAudioTranscriptionAsResponseObject; + + #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "non-model response value needed" + getAudioTranslationAsPlainText is Azure.OpenAI.getAudioTranslationAsPlainText; + + #suppress "@azure-tools/typespec-azure-core/byos" "representation of existing multipart/form-data operation" + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "non-model response value needed" + getAudioTranslationAsResponseObject is Azure.OpenAI.getAudioTranslationAsResponseObject; + + getCompletions is Azure.OpenAI.getCompletions; + getChatCompletions is Azure.OpenAI.getChatCompletions; + getChatCompletionsWithAzureExtensions is Azure.OpenAI.getChatCompletionsWithAzureExtensions; + + getImageGenerations is Azure.OpenAI.getImageGenerations; + + getEmbeddings is Azure.OpenAI.getEmbeddings; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/client/custom_visibility.tsp b/specification/cognitiveservices/OpenAI.Inference/client/custom_visibility.tsp new file mode 100644 index 000000000000..75c43f4c1d01 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/client/custom_visibility.tsp @@ -0,0 +1,47 @@ +import "@azure-tools/typespec-client-generator-core"; +import "../main.tsp"; + +using Azure.ClientGenerator.Core; + +// Azure-specific Chat Completions with extensions should be handled by clients as a conditional selection within the +// shared Chat Completions route, with the selection gated by the presence or non-presence of additional child +// configuration options on the request payload options model. +@@access(Azure.OpenAI.getChatCompletionsWithAzureExtensions, Access.internal); + +// Some models from routes with suppressed visibility are still desired for custom public surface. +@@access(Azure.OpenAI.ImageGenerationOptions, Access.public); +@@usage(Azure.OpenAI.ImageGenerationOptions, Usage.input | Usage.output); +@@access(Azure.OpenAI.ImageSize, Access.public); +@@usage(Azure.OpenAI.ImageGenerations, Usage.input | Usage.output); + +// Java will need to have those models expose in public surface. +@@access(Azure.OpenAI.AudioTranscription, Access.public, "java"); +@@access(Azure.OpenAI.AudioTranscriptionOptions, Access.public, "java"); +@@access(Azure.OpenAI.AudioTranslation, Access.public, "java"); +@@access(Azure.OpenAI.AudioTranslationOptions, Access.public, "java"); + +@@access(Azure.OpenAI.AzureCognitiveSearchIndexFieldMappingOptions, + Access.public +); +@@usage(Azure.OpenAI.AzureCognitiveSearchIndexFieldMappingOptions, Usage.input); + +@@access(Azure.OpenAI.AzureCognitiveSearchQueryType, Access.public); +@@usage(Azure.OpenAI.AzureCognitiveSearchQueryType, Usage.input); + +@@access(Azure.OpenAI.AzureCognitiveSearchChatExtensionConfiguration, + Access.public +); +@@usage(Azure.OpenAI.AzureCognitiveSearchChatExtensionConfiguration, + Usage.input +); + +// Remap "model" nomenclature to "DeploymentName" in appropriate containers; comments should clarify the dual use +@@projectedName(Azure.OpenAI.ImageGenerationOptions.`model`, + "csharp", + "DeploymentName" +); + +@@projectedName(Azure.OpenAI.ChatResponseMessage.context, + "csharp", + "AzureExtensionsContext" +); diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/audio_transcription_object.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/audio_transcription_object.json new file mode 100644 index 000000000000..c7310fd248bb --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/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": "2023-12-01-preview", + "deploymentId": "" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/audio_transcription_text.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/audio_transcription_text.json new file mode 100644 index 000000000000..44582aacc4a4 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/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": "2023-12-01-preview", + "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/2023-12-01-preview/audio_translation_object.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/audio_translation_object.json new file mode 100644 index 000000000000..d785bffab0dc --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/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": "2023-12-01-preview", + "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/2023-12-01-preview/audio_translation_text.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/audio_translation_text.json new file mode 100644 index 000000000000..e29bc1e288e1 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/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": "2023-12-01-preview", + "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/2023-12-01-preview/chat_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/chat_completions.json new file mode 100644 index 000000000000..7c0c5150824f --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/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": "2023-12-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/completions.json new file mode 100644 index 000000000000..02267a4ac850 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/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": "2023-12-01-preview", + "deploymentId": "", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/embeddings.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/embeddings.json new file mode 100644 index 000000000000..a5be4ad51103 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/embeddings.json @@ -0,0 +1,1567 @@ +{ + "operationId": "GetEmbeddings", + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-12-01-preview", + "deploymentId": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json new file mode 100644 index 000000000000..24d661ad76fd --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_aml_index.json @@ -0,0 +1,62 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "title": "Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-12-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "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/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..0968a3dbea37 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_advanced.json @@ -0,0 +1,86 @@ +{ + "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": "2023-12-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "AzureCognitiveSearch", + "parameters": { + "endpoint": "{search endpoint}", + "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/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..860e6e9e4b22 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_image_vector.json @@ -0,0 +1,67 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "title": "Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-12-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "AzureCognitiveSearch", + "parameters": { + "endpoint": "{search endpoint}", + "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/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json similarity index 100% rename from specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/extensions_chat_completions.json rename to specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_azure_search_minimum.json diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json new file mode 100644 index 000000000000..d2d8295cefa8 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_cosmos_db.json @@ -0,0 +1,75 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "title": "Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-12-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "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": { + "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/2023-12-01-preview/extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json new file mode 100644 index 000000000000..01680301b679 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_elasticsearch.json @@ -0,0 +1,66 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "title": "Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-12-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "Elasticsearch", + "parameters": { + "endpoint": "{search endpoint}", + "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/2023-12-01-preview/extensions_chat_completions_pinecone.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json new file mode 100644 index 000000000000..2cbd35ec2ab5 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/extensions_chat_completions_pinecone.json @@ -0,0 +1,78 @@ +{ + "operationId": "GetChatCompletionsWithAzureExtensions", + "title": "Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-12-01-preview", + "deploymentId": "", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "dataSources": [ + { + "type": "Pinecone", + "parameters": { + "authentication": { + "type": "APIKey", + "apiKey": "{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/2023-12-01-preview/get_image_operation_status.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/get_image_operation_status.json new file mode 100644 index 000000000000..8e42b89bf30a --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/get_image_operation_status.json @@ -0,0 +1,27 @@ +{ + "operationId": "GetAzureBatchImageGenerationOperationStatus", + "title": "Returns the status of the images operation", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-12-01-preview", + "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/2023-12-01-preview/image_generation.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/image_generation.json new file mode 100644 index 000000000000..56c47c410071 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/image_generation.json @@ -0,0 +1,31 @@ +{ + "operationId": "GetImageGenerations", + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2023-12-01-preview", + "deploymentId": "", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + }, + { + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_01.png?se=2023-10-27T17%3A45%3A09Z&..." + } + ], + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + } + } + } +} diff --git a/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/start_generate_image.json b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/start_generate_image.json new file mode 100644 index 000000000000..1da29ebdfe21 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/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": "2023-12-01-preview", + "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 3249779f8486..89f22a7a99c8 100644 --- a/specification/cognitiveservices/OpenAI.Inference/main.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/main.tsp @@ -58,4 +58,7 @@ enum ServiceApiVersions { @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2023_09_01_Preview: "2023-09-01-preview", + + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2023_12_01_Preview: "2023-12-01-preview", } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp index aea912a57508..1df44ae8b3d3 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_transcription.tsp @@ -41,6 +41,13 @@ model AudioTranscriptionOptions { @projectedName("csharp", "AudioData") file: bytes; + @doc(""" + The optional filename or descriptive identifier to associate with with the audio data. + """) + // Note: although this isn't explicitly part of the request schema per documentation, it is present via the encoded + // content-disposition header for the binary section of the multipart/form-data content. + filename?: string; + @doc(""" The requested format of the transcription response data, which will influence the content and detail of the result. """) diff --git a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp index 1638107caf8a..1e0d8337eb53 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/audio/audio_translation.tsp @@ -41,6 +41,13 @@ model AudioTranslationOptions { @projectedName("csharp", "AudioData") file: bytes; + @doc(""" + The optional filename or descriptive identifier to associate with with the audio data. + """) + // Note: although this isn't explicitly part of the request schema per documentation, it is present via the encoded + // content-disposition header for the binary section of the multipart/form-data content. + filename?: string; + @doc(""" The requested format of the translation response data, which will influence the content and detail of the result. """) diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp index 9f024f1f0312..fd9071fbdcfb 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_chat_extensions.tsp @@ -1,26 +1,16 @@ import "@typespec/versioning"; - import "./chat_completions.tsp"; -import "./azure_cognitive_search_options.tsp"; +import "./chat_messages.tsp"; +import "./extensions/oyd/azure_cognitive_search_options.tsp"; +import "./extensions/oyd/azure_machinelearning_index_options.tsp"; +import "./extensions/oyd/azure_cosmosdb_options.tsp"; +import "./extensions/oyd/elasticsearch_options.tsp"; +import "./extensions/oyd/pinecone_options.tsp"; namespace Azure.OpenAI; using TypeSpec.Versioning; -// Explanatory notes for Azure OpenAI chat extensions (as of 2023-08-01-preview): -// - Although the REST API serves this capability via a distinct /extensions/chat/completions route, client libraries -// should abstract that detail and dynamically dispatch this on the normal chat completions path, using the -// specification of extensions in the options (request body payload) as the decision mechanism -// - A future service API version will merge /extensions/chat/completions into /chat/completions and, at that time, -// the above ensures there's no customer-facing change or disruption -// - The current schema for specifying extensions uses a supplementary `dataSources` array at the top level of the -// request payload. This can be problematic for dynamic selection in some languages (minimally, ambiguous or -// confusing) and so libraries should instead wrap this in a custom "sub-options" type: wire format will realize as -// ChatCompletionsOptions.DataSources, but libraries should present that instead as -// ChatCompletionsOptions.AzureExtensionsOptions.Extensions -// - Another future service API version (TBD, perhaps the same that merges into /chat/completions) should reflect the -// structural and naming changes in the wire format - @added(ServiceApiVersions.v2023_08_01_Preview) @doc(""" A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat @@ -30,8 +20,25 @@ using TypeSpec.Versioning; enum AzureChatExtensionType { @doc("Represents the use of Azure Cognitive Search as an Azure OpenAI chat extension.") azureCognitiveSearch: "AzureCognitiveSearch", + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("Represents the use of Azure Machine Learning index as an Azure OpenAI chat extension.") + azureMachineLearningIndex: "AzureMLIndex", + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension.") + azureCosmosDB: "AzureCosmosDB", + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("Represents the use of Elasticsearch® index as an Azure OpenAI chat extension.") + elasticsearch: "Elasticsearch", + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("Represents the use of Pinecone index as an Azure OpenAI chat extension.") + pinecone: "Pinecone", } +@discriminator("type") @added(ServiceApiVersions.v2023_08_01_Preview) @doc(""" A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat @@ -44,14 +51,6 @@ model AzureChatExtensionConfiguration { Azure chat extensions are only compatible with Azure OpenAI. """) type: AzureChatExtensionType; - - #suppress "@azure-tools/typespec-azure-core/no-unknown" "API explicitly uses arbitrary JSON structure" - @doc(""" - The configuration payload used for the Azure chat extension. The structure payload details are specific to the - extension being configured. - Azure chat extensions are only compatible with Azure OpenAI. - """) - parameters: unknown; } @added(ServiceApiVersions.v2023_08_01_Preview) @@ -67,5 +66,86 @@ model AzureChatExtensionsMessageContext { course of generating a chat completions response that was augmented by capabilities from Azure OpenAI chat extensions. """) - messages?: ChatMessage[]; + messages?: ChatResponseMessage[]; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A representation of the available options for the Azure OpenAI grounding enhancement.") +model AzureChatGroundingEnhancementConfiguration { + @doc("Specifies whether the enhancement is enabled.") + enabled: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "established industry acronym" +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement.") +model AzureChatOCREnhancementConfiguration { + @doc("Specifies whether the enhancement is enabled.") + enabled: boolean; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A representation of the available Azure OpenAI enhancement configurations.") +model AzureChatEnhancementConfiguration { + @doc("A representation of the available options for the Azure OpenAI grounding enhancement.") + grounding?: AzureChatGroundingEnhancementConfiguration; + + @doc("A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement.") + ocr?: AzureChatOCREnhancementConfiguration; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided +in the request. +""") +model AzureChatEnhancements { + @doc("The grounding enhancement that returns the bounding box of the objects detected in the image.") + grounding?: AzureGroundingEnhancement; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("The grounding enhancement that returns the bounding box of the objects detected in the image.") +model AzureGroundingEnhancement { + @doc("The lines of text detected by the grounding enhancement.") + lines: AzureGroundingEnhancementLine[]; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.") +model AzureGroundingEnhancementLine { + @doc("The text within the line.") + text: string; + + @doc("An array of spans that represent detected objects and its bounding box information.") + spans: AzureGroundingEnhancementLineSpan[]; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A span object that represents a detected object and its bounding box information.") +model AzureGroundingEnhancementLineSpan { + @doc("The text content of the span that represents the detected object.") + text: string; + + @doc(""" + The character offset within the text where the span begins. This offset is defined as the position of the first + character of the span, counting from the start of the text as Unicode codepoints. + """) + offset: int32; + + @doc("The length of the span in characters, measured in Unicode codepoints.") + length: int32; + + @doc("An array of objects representing points in the polygon that encloses the detected object.") + polygon: AzureGroundingEnhancementCoordinatePoint[]; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A representation of a single polygon point as used by the Azure grounding enhancement.") +model AzureGroundingEnhancementCoordinatePoint { + @doc("The x-coordinate (horizontal axis) of the point.") + x: float32; + + @doc("The y-coordinate (vertical axis) of the point.") + y: float32; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_cognitive_search_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_cognitive_search_options.tsp deleted file mode 100644 index eebe186dc478..000000000000 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_cognitive_search_options.tsp +++ /dev/null @@ -1,105 +0,0 @@ -import "@typespec/versioning"; - -import "./azure_chat_extensions.tsp"; - -namespace Azure.OpenAI; - -using TypeSpec.Versioning; - -@doc("Optional settings to control how fields are processed when using a configured Azure Cognitive Search resource.") -@added(ServiceApiVersions.v2023_08_01_Preview) -model AzureCognitiveSearchIndexFieldMappingOptions { - @doc("The name of the index field to use as a title.") - @projectedName("csharp", "TitleFieldName") - titleField?: string; - - @doc("The name of the index field to use as a URL.") - @projectedName("csharp", "UrlFieldName") - urlField?: string; - - @doc("The name of the index field to use as a filepath.") - @projectedName("csharp", "FilepathFieldName") - filepathField?: string; - - @doc("The names of index fields that should be treated as content.") - @projectedName("csharp", "ContentFieldNames") - contentFieldNames?: string[]; - - @doc("The separator pattern that content fields should use.") - @projectedName("csharp", "ContentFieldSeparator") - contentFieldSeparator?: string; - - @doc("The names of fields that represent vector data.") - @projectedName("csharp", "VectorFieldNames") - vectorFields?: string[]; -} - -@doc(""" -The type of Azure Cognitive Search retrieval query that should be executed when using it as an Azure OpenAI chat extension. -""") -@added(ServiceApiVersions.v2023_08_01_Preview) -enum AzureCognitiveSearchQueryType { - @doc("Represents the default, simple query parser.") - simple: "simple", - - @doc("Represents the semantic query parser for advanced semantic modeling.") - semantic: "semantic", - - @doc("Represents vector search over computed data.") - vector: "vector", - - @doc("Represents a combination of the simple query strategy with vector data.") - vectorSimpleHybrid: "vectorSimpleHybrid", - - @doc("Represents a combination of semantic search and vector data querying.") - vectorSemanticHybrid: "vectorSemanticHybrid", -} - -@added(ServiceApiVersions.v2023_08_01_Preview) -@doc(""" -A specific representation of configurable options for Azure Cognitive Search when using it as an Azure OpenAI chat -extension. -""") -model AzureCognitiveSearchChatExtensionConfiguration { - @doc(""" - The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its - default value for Azure Cognitive Search. - """) - type: AzureChatExtensionType.azureCognitiveSearch; - - @doc("The absolute endpoint path for the Azure Cognitive Search resource to use.") - @projectedName("csharp", "SearchEndpoint") - endpoint: url; - - @doc("The API admin key to use with the specified Azure Cognitive Search endpoint.") - @projectedName("csharp", "SearchKey") - key: string; - - @doc("The name of the index to use as available in the referenced Azure Cognitive Search resource.") - indexName: string; - - @doc("Customized field mapping behavior to use when interacting with the search index.") - @projectedName("csharp", "FieldMappingOptions") - fieldsMapping?: AzureCognitiveSearchIndexFieldMappingOptions; - - #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" - @doc("The configured top number of documents to feature for the configured query.") - @projectedName("csharp", "DocumentCount") - topNDocuments?: int32; - - @doc("The query type to use with Azure Cognitive Search.") - queryType?: AzureCognitiveSearchQueryType; - - @doc("Whether queries should be restricted to use of indexed data.") - @projectedName("csharp", "ShouldRestrictResultScope") - inScope?: boolean; - - @doc("The additional semantic configuration for the query.") - semanticConfiguration?: string; - - @doc("When using embeddings for search, specifies the resource URL from which embeddings should be retrieved.") - embeddingEndpoint?: url; - - @doc("When using embeddings, specifies the API key to use with the provided embeddings endpoint.") - embeddingKey?: string; -} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp new file mode 100644 index 000000000000..ec4416042ad5 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp @@ -0,0 +1,175 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; + +namespace Azure.OpenAI; + +@added(ServiceApiVersions.v2023_06_01_Preview) +@doc("Ratings for the intensity and risk level of harmful content.") +enum ContentFilterSeverity { + @doc(""" + Content may be related to violence, self-harm, sexual, or hate categories but the terms + are used in general, journalistic, scientific, medical, and similar professional contexts, + which are appropriate for most audiences. + """) + safe: "safe", + + @doc(""" + Content that expresses prejudiced, judgmental, or opinionated views, includes offensive + use of language, stereotyping, use cases exploring a fictional world (for example, gaming, + literature) and depictions at low intensity. + """) + low: "low", + + @doc(""" + Content that uses offensive, insulting, mocking, intimidating, or demeaning language + towards specific identity groups, includes depictions of seeking and executing harmful + instructions, fantasies, glorification, promotion of harm at medium intensity. + """) + medium: "medium", + + @doc(""" + Content that displays explicit and severe harmful instructions, actions, + damage, or abuse; includes endorsement, glorification, or promotion of severe + harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual + power exchange or abuse. + """) + high: "high", +} + +@added(ServiceApiVersions.v2023_06_01_Preview) +@doc("Information about filtered content severity level and if it has been filtered or not.") +model ContentFilterResult { + @doc("Ratings for the intensity and risk level of filtered content.") + @projectedName("json", "severity") + severity: ContentFilterSeverity; + + @doc("A value indicating whether or not the content has been filtered.") + @projectedName("json", "filtered") + filtered: boolean; +} + +alias ContentFilterResultsBase = { + @doc(""" + Describes language related to anatomical organs and genitals, romantic relationships, + acts portrayed in erotic or affectionate terms, physical sexual acts, including + those portrayed as an assault or a forced sexual violent act against one’s will, + prostitution, pornography, and abuse. + """) + sexual?: ContentFilterResult; + + @doc(""" + Describes language related to physical actions intended to hurt, injure, damage, or + kill someone or something; describes weapons, etc. + """) + violence?: ContentFilterResult; + + @doc(""" + Describes language attacks or uses that include pejorative or discriminatory language + with reference to a person or identity group on the basis of certain differentiating + attributes of these groups including but not limited to race, ethnicity, nationality, + gender identity and expression, sexual orientation, religion, immigration status, ability + status, personal appearance, and body size. + """) + hate?: ContentFilterResult; + + @doc(""" + Describes language related to physical actions intended to purposely hurt, injure, + or damage one’s body, or kill oneself. + """) + @projectedName("json", "self_harm") + selfHarm?: ContentFilterResult; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("Describes whether profanity was detected.") + profanity?: ContentFilterDetectionResult; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @projectedName("json", "custom_blocklists") + @doc("Describes detection results against configured custom blocklists.") + customBlocklists?: ContentFilterBlocklistIdResult[]; + + @doc(""" + Describes an error returned if the content filtering system is + down or otherwise unable to complete the operation in time. + """) + error?: Azure.Core.Foundations.Error; +}; + +@added(ServiceApiVersions.v2023_06_01_Preview) +@doc("Information about content filtering evaluated against input data to Azure OpenAI.") +model ContentFilterResultDetailsForPrompt { + ...ContentFilterResultsBase; + + @doc("Whether a jailbreak attempt was detected in the prompt.") + @added(ServiceApiVersions.v2023_12_01_Preview) + jailbreak?: ContentFilterDetectionResult; +} + +@added(ServiceApiVersions.v2023_06_01_Preview) +@doc("Information about content filtering evaluated against generated model output.") +model ContentFilterResultsForChoice { + ...ContentFilterResultsBase; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @projectedName("json", "protected_material_text") + @doc("Information about detection of protected text material.") + protectedMaterialText?: ContentFilterDetectionResult; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @projectedName("json", "protected_material_code") + @doc("Information about detection of protected code material.") + protectedMaterialCode?: ContentFilterCitedDetectionResult; +} + +@added(ServiceApiVersions.v2023_06_01_Preview) +@doc(""" +Content filtering results for a single prompt in the request. +""") +model ContentFilterResultsForPrompt { + @doc("The index of this prompt in the set of prompt results") + @projectedName("json", "prompt_index") + promptIndex: int32; + + @doc("Content filtering results for this prompt") + @projectedName("json", "content_filter_results") + contentFilterResults: ContentFilterResultDetailsForPrompt; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("Represents the outcome of a detection operation performed by content filtering.") +model ContentFilterDetectionResult { + @doc("A value indicating whether or not the content has been filtered.") + filtered: boolean; + + @doc("A value indicating whether detection occurred, irrespective of severity or whether the content was filtered.") + detected: boolean; +} + +@doc("Represents the outcome of a detection operation against protected resources as performed by content filtering.") +@added(ServiceApiVersions.v2023_12_01_Preview) +model ContentFilterCitedDetectionResult { + ...ContentFilterDetectionResult; + + @projectedName("json", "URL") + @doc("The internet location associated with the detection.") + url?: url; + + @doc("The license description associated with the detection.") + license: string; +} + +@doc("Represents the outcome of an evaluation against a custom blocklist as performed by content filtering.") +@added(ServiceApiVersions.v2023_12_01_Preview) +model ContentFilterBlocklistIdResult { + @doc("The ID of the custom blocklist evaluated.") + id: string; + + @doc("A value indicating whether or not the content has been filtered.") + filtered: boolean; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp index aad348dcc19c..9bbd80006341 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_completions.tsp @@ -3,8 +3,11 @@ import "@typespec/http"; import "@typespec/versioning"; import "./azure_chat_extensions.tsp"; +import "./azure_content_filtering.tsp"; +import "./chat_messages.tsp"; import "./common.tsp"; import "./functions.tsp"; +import "./tools.tsp"; using TypeSpec.Rest; using TypeSpec.Http; @@ -12,59 +15,17 @@ using TypeSpec.Versioning; namespace Azure.OpenAI; -@doc("A description of the intended purpose of a message within a chat completions interaction.") -enum ChatRole { - @doc("The role that instructs or sets the behavior of the assistant.") - system: "system", - - @doc("The role that provides responses to system-instructed, user-prompted input.") - assistant: "assistant", - - @doc("The role that provides input for chat completions.") - user: "user", - - @doc("The role that provides function results for chat completions.") - @added(ServiceApiVersions.v2023_07_01_Preview) - function: "function", - - @doc("The role that represents extension tool activity within a chat completions operation.") - @added(ServiceApiVersions.v2023_08_01_Preview) - tool: "tool", -} - -@doc("A single, role-attributed message within a chat completion interaction.") -model ChatMessage { - @doc("The role associated with this message payload.") - @projectedName("json", "role") - role: ChatRole; - - #suppress "@azure-tools/typespec-azure-core/no-nullable" "we explicitly want a nullable string" - @doc("The text associated with this message payload.") - @projectedName("json", "content") - content: string | null; - - @doc(""" - The name of the author of this message. `name` is required if role is `function`, and it should be the name of the - function whose response is in the `content`. May contain a-z, A-Z, 0-9, and underscores, with a maximum length of - 64 characters. - """) - @added(ServiceApiVersions.v2023_07_01_Preview) - name?: string; - - @doc("The name and arguments of a function that should be called, as generated by the model.") - @added(ServiceApiVersions.v2023_07_01_Preview) - @projectedName("json", "function_call") - functionCall?: FunctionCall; +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("The valid response formats Chat Completions can provide. Used to enable JSON mode.") +enum ChatCompletionsResponseFormat { + @doc("Use the default, plain text response format.") + text: "text", @doc(""" - Additional context data associated with a chat message when requesting chat completions using compatible Azure - OpenAI chat extensions. This includes information like the intermediate data source retrievals used to service a - request. - This context information is only populated when using Azure OpenAI with chat extensions capabilities configured. + Use a response format that guarantees emission of a valid JSON object. Only structure is guaranteed and contents must + still be validated. """) - @added(ServiceApiVersions.v2023_08_01_Preview) - @projectedName("csharp", "AzureExtensionsContext") - context?: AzureChatExtensionsMessageContext; + jsonObject: "json_object", } @doc(""" @@ -72,6 +33,7 @@ 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. """) +@added(ServiceApiVersions.v2023_05_15) model ChatCompletionsOptions { @doc(""" The collection of context messages associated with this chat completions request. @@ -80,10 +42,11 @@ model ChatCompletionsOptions { Assistant roles. """) @projectedName("json", "messages") - messages: ChatMessage[]; + messages: ChatRequestMessage[]; @doc("A list of functions the model may generate JSON inputs for.") @added(ServiceApiVersions.v2023_07_01_Preview) + @removed(ServiceApiVersions.v2023_12_01_Preview) functions?: FunctionDefinition[]; @doc(""" @@ -94,6 +57,7 @@ model ChatCompletionsOptions { """) @projectedName("json", "function_call") @added(ServiceApiVersions.v2023_07_01_Preview) + @removed(ServiceApiVersions.v2023_12_01_Preview) functionCall?: FunctionCallConfig; @doc("The maximum number of tokens to generate.") @@ -204,6 +168,34 @@ model ChatCompletionsOptions { @projectedName("json", "dataSources") @projectedName("csharp", "InternalAzureExtensionsDataSources") dataSources?: AzureChatExtensionConfiguration[]; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("If provided, the configuration options for available Azure OpenAI chat enhancements.") + enhancements?: AzureChatEnhancementConfiguration; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc(""" + If specified, the system will make a best effort to sample deterministically such that repeated requests with the + same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the + system_fingerprint response parameter to monitor changes in the backend." + """) + seed?: int64; + + @projectedName("json", "response_format") + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("An object specifying the format that the model must output. Used to enable JSON mode.") + responseFormat?: ChatCompletionsResponseFormat; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("The available tool definitions that the chat completions request can use, including caller-defined functions.") + tools?: ChatCompletionsToolDefinition[]; + + @projectedName("json", "tool_choice") + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc(""" + If specified, the model will configure which of the provided tools it can use for the chat completions response. + """) + toolChoice?: ChatCompletionsToolSelection; } @doc(""" @@ -211,10 +203,11 @@ The representation of a single prompt completion as part of an overall chat comp Generally, `n` choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated. """) +@added(ServiceApiVersions.v2023_05_15) model ChatChoice { @doc("The chat message for a given chat completions prompt.") @projectedName("json", "message") - message?: ChatMessage; + message?: ChatResponseMessage; @doc("The ordered index associated with this chat completions choice.") @projectedName("json", "index") @@ -226,10 +219,19 @@ model ChatChoice { @projectedName("json", "finish_reason") finishReason: CompletionsFinishReason | null; + // Note: this property is currently speculative via observation and not yet documented anywhere. + @doc(""" + The reason the model stopped generating tokens, together with any applicable details. + This structured representation replaces 'finish_reason' for some models. + """) + @added(ServiceApiVersions.v2023_12_01_Preview) + @projectedName("json", "finish_details") + finishDetails?: ChatFinishDetails; + @doc("The delta message content for a streaming response.") @projectedName("json", "delta") @projectedName("csharp", "InternalStreamingDeltaMessage") - delta?: ChatMessage; + delta?: ChatResponseMessage; @doc(""" Information about the content filtering category (hate, sexual, violence, self_harm), if it @@ -238,7 +240,15 @@ model ChatChoice { """) @added(ServiceApiVersions.v2023_06_01_Preview) @projectedName("json", "content_filter_results") - contentFilterResults?: ContentFilterResults; + contentFilterResults?: ContentFilterResultsForChoice; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc(""" + Represents the output results of Azure OpenAI enhancements to chat completions, as configured via the matching input + provided in the request. This supplementary information is only available when using Azure OpenAI and only when the + request is configured to use enhancements. + """) + enhancements?: AzureChatEnhancements; } @doc(""" @@ -246,6 +256,7 @@ Representation of the response data from a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data. """) +@added(ServiceApiVersions.v2023_05_15) model ChatCompletions { @doc("A unique identifier associated with this chat completions response.") @projectedName("json", "id") @@ -274,7 +285,15 @@ model ChatCompletions { """) @added(ServiceApiVersions.v2023_06_01_Preview) @projectedName("json", "prompt_filter_results") - promptFilterResults?: PromptFilterResult[]; + promptFilterResults?: ContentFilterResultsForPrompt[]; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @projectedName("json", "system_fingerprint") + @doc(""" + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that + might impact determinism. + """) + systemFingerprint: string; @doc(""" Usage information for tokens processed and generated as part of this completions operation. @@ -282,3 +301,31 @@ model ChatCompletions { @projectedName("json", "usage") usage: CompletionsUsage; } + +@added(ServiceApiVersions.v2023_12_01_Preview) +@discriminator("type") +@doc("An abstract representation of structured information about why a chat completions response terminated.") +model ChatFinishDetails { + @doc("The object type.") + type: string; +} + +@doc("A structured representation of a stop reason that signifies natural termination by the model.") +@added(ServiceApiVersions.v2023_12_01_Preview) +model StopFinishDetails extends ChatFinishDetails { + @doc("The object type, which is always 'stop' for this object.") + type: "stop"; + + @doc("The token sequence that the model terminated with.") + stop: string; +} + +@doc(""" +A structured representation of a stop reason that signifies a token limit was reached before the model could naturally +complete. +""") +@added(ServiceApiVersions.v2023_12_01_Preview) +model MaxTokensFinishDetails extends ChatFinishDetails { + @doc("The object type, which is always 'max_tokens' for this object.") + type: "max_tokens"; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp new file mode 100644 index 000000000000..261f8ef9f611 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/chat_messages.tsp @@ -0,0 +1,210 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; + +import "./azure_chat_extensions.tsp"; +import "./common.tsp"; +import "./functions.tsp"; +import "./tools.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Azure.OpenAI; + +#suppress "@azure-tools/typespec-autorest/union-unsupported" "External API shape is defined in OpenAPI 3.0 as oneOf." +alias ChatMessageContent = string | ChatMessageContentItem[]; + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("An abstract representation of a structured content item within a chat message.") +@discriminator("type") +model ChatMessageContentItem { + @doc("The discriminated object type.") + type: string; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A structured chat content item containing plain text.") +model ChatMessageTextContentItem extends ChatMessageContentItem { + @doc("The discriminated object type: always 'text' for this type.") + type: "text"; + + @doc("The content of the message.") + text: string; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A representation of the possible image detail levels for image-based chat completions message content.") +enum ChatMessageImageDetailLevel { + @doc("Specifies that the model should determine which detail level to apply using heuristics like image size.") + auto: "auto", + + @doc(""" + Specifies that image evaluation should be constrained to the 'low-res' model that may be faster and consume fewer + tokens but may also be less accurate for highly detailed images. + """) + low: "low", + + @doc(""" + Specifies that image evaluation should enable the 'high-res' model that may be more accurate for highly detailed + images but may also be slower and consume more tokens. + """) + high: "high", +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A structured chat content item containing an image reference.") +model ChatMessageImageContentItem extends ChatMessageContentItem { + @doc("The discriminated object type: always 'image_url' for this type.") + type: "image_url"; + + @doc("An internet location, which must be accessible to the model,from which the image may be retrieved.") + @projectedName("json", "image_url") + imageUrl: ChatMessageImageUrl; +} + +@doc("An internet location from which the model may retrieve an image.") +@added(ServiceApiVersions.v2023_12_01_Preview) +model ChatMessageImageUrl { + @doc("The URL of the image.") + url: url; + + @doc(""" + The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and + accuracy. + """) + detail?: ChatMessageImageDetailLevel; +} + +@discriminator("role") +@added(ServiceApiVersions.v2023_05_15) +@doc("An abstract representation of a chat message as provided in a request.") +model ChatRequestMessage { + @doc("The chat role associated with this message.") + role: ChatRole; +} + +@added(ServiceApiVersions.v2023_05_15) +@doc(""" +A request chat message containing system instructions that influence how the model will generate a chat completions +response. +""") +model ChatRequestSystemMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'system' for system messages.") + role: ChatRole.system; + + @doc("The contents of the system message.") + content: string; + + @doc("An optional name for the participant.") + name?: string; +} + +@added(ServiceApiVersions.v2023_05_15) +@doc("A request chat message representing user input to the assistant.") +model ChatRequestUserMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'user' for user messages.") + role: ChatRole.user; + + @doc("The contents of the user message, with available input types varying by selected model.") + content: ChatMessageContent; + + @doc("An optional name for the participant.") + name?: string; +} + +@added(ServiceApiVersions.v2023_05_15) +@doc("A request chat message representing response or action from the assistant.") +model ChatRequestAssistantMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'assistant' for assistant messages.") + role: ChatRole.assistant; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" + @doc("The content of the message.") + content: string | null; + + @doc("An optional name for the participant.") + name?: string; + + @projectedName("json", "tool_calls") + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc(""" + The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat + completions request to resolve as configured. + """) + toolCalls?: ChatCompletionsToolCall[]; + + @added(ServiceApiVersions.v2023_07_01_Preview) + @removed(ServiceApiVersions.v2023_12_01_Preview) + @projectedName("json", "function_call") + @doc(""" + The function call that must be resolved and have its output appended to subsequent input messages for the chat + completions request to resolve as configured. + """) + functionCall?: FunctionCall; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A request chat message representing requested output from a configured tool.") +model ChatRequestToolMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'tool' for tool messages.") + role: ChatRole.tool; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" + @doc("The content of the message.") + content: string | null; + + @projectedName("json", "tool_call_id") + @doc("The ID of the tool call resolved by the provided content.") + toolCallId: string; +} + +@added(ServiceApiVersions.v2023_07_01_Preview) +@removed(ServiceApiVersions.v2023_12_01_Preview) +@doc("A request chat message representing requested output from a configured function.") +model ChatRequestFunctionMessage extends ChatRequestMessage { + @doc("The chat role associated with this message, which is always 'function' for function messages.") + role: ChatRole.function; + + @doc("The name of the function that was called to produce output.") + name: string; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI specification" + @doc("The output of the function as requested by the function call.") + content: string | null; +} + +@added(ServiceApiVersions.v2023_05_15) +@doc("A representation of a chat message as received in a response.") +model ChatResponseMessage { + @doc("The chat role associated with the message.") + role: ChatRole; + + #suppress "@azure-tools/typespec-azure-core/no-nullable" "explicitly nullable in mirrored API" + @doc("The content of the message.") + content: string | null; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @projectedName("json", "tool_calls") + @doc(""" + The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat + completions request to resolve as configured. + """) + toolCalls?: ChatCompletionsToolCall[]; + + @added(ServiceApiVersions.v2023_07_01_Preview) + @projectedName("json", "function_call") + @doc(""" + The function call that must be resolved and have its output appended to subsequent input messages for the chat + completions request to resolve as configured. + """) + functionCall?: FunctionCall; + + @added(ServiceApiVersions.v2023_08_01_Preview) + @doc(""" + If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those + extensions while processing the chat completions request. + """) + context?: AzureChatExtensionsMessageContext; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp index bac0da781faf..3c5b697aef47 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/common.tsp @@ -43,103 +43,28 @@ enum CompletionsFinishReason { @doc("Completion ended normally, with the model requesting a function to be called.") @added(ServiceApiVersions.v2023_07_01_Preview) functionCall: "function_call", -} - -@added(ServiceApiVersions.v2023_06_01_Preview) -@doc("Ratings for the intensity and risk level of harmful content.") -enum ContentFilterSeverity { - @doc(""" - Content may be related to violence, self-harm, sexual, or hate categories but the terms - are used in general, journalistic, scientific, medical, and similar professional contexts, - which are appropriate for most audiences. - """) - safe: "safe", - - @doc(""" - Content that expresses prejudiced, judgmental, or opinionated views, includes offensive - use of language, stereotyping, use cases exploring a fictional world (for example, gaming, - literature) and depictions at low intensity. - """) - low: "low", - - @doc(""" - Content that uses offensive, insulting, mocking, intimidating, or demeaning language - towards specific identity groups, includes depictions of seeking and executing harmful - instructions, fantasies, glorification, promotion of harm at medium intensity. - """) - medium: "medium", - - @doc(""" - Content that displays explicit and severe harmful instructions, actions, - damage, or abuse; includes endorsement, glorification, or promotion of severe - harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual - power exchange or abuse. - """) - high: "high", -} - -@added(ServiceApiVersions.v2023_06_01_Preview) -@doc("Information about filtered content severity level and if it has been filtered or not.") -model ContentFilterResult { - @doc("Ratings for the intensity and risk level of filtered content.") - @projectedName("json", "severity") - severity: ContentFilterSeverity; - @doc("A value indicating whether or not the content has been filtered.") - @projectedName("json", "filtered") - filtered: boolean; + @doc("Completion ended with the model calling a provided tool for output.") + @added(ServiceApiVersions.v2023_12_01_Preview) + toolCalls: "tool_calls", } -@added(ServiceApiVersions.v2023_06_01_Preview) -@doc("Information about the content filtering category, if it has been detected.") -model ContentFilterResults { - @doc(""" - Describes language related to anatomical organs and genitals, romantic relationships, - acts portrayed in erotic or affectionate terms, physical sexual acts, including - those portrayed as an assault or a forced sexual violent act against one’s will, - prostitution, pornography, and abuse. - """) - sexual?: ContentFilterResult; - - @doc(""" - Describes language related to physical actions intended to hurt, injure, damage, or - kill someone or something; describes weapons, etc. - """) - violence?: ContentFilterResult; +@doc("A description of the intended purpose of a message within a chat completions interaction.") +enum ChatRole { + @doc("The role that instructs or sets the behavior of the assistant.") + system: "system", - @doc(""" - Describes language attacks or uses that include pejorative or discriminatory language - with reference to a person or identity group on the basis of certain differentiating - attributes of these groups including but not limited to race, ethnicity, nationality, - gender identity and expression, sexual orientation, religion, immigration status, ability - status, personal appearance, and body size. - """) - hate?: ContentFilterResult; + @doc("The role that provides responses to system-instructed, user-prompted input.") + assistant: "assistant", - @doc(""" - Describes language related to physical actions intended to purposely hurt, injure, - or damage one’s body, or kill oneself. - """) - @projectedName("json", "self_harm") - selfHarm?: ContentFilterResult; + @doc("The role that provides input for chat completions.") + user: "user", - @doc(""" - Describes an error returned if the content filtering system is - down or otherwise unable to complete the operation in time. - """) - error?: Azure.Core.Foundations.Error; -} - -@added(ServiceApiVersions.v2023_06_01_Preview) -@doc(""" -Content filtering results for a single prompt in the request. -""") -model PromptFilterResult { - @doc("The index of this prompt in the set of prompt results") - @projectedName("json", "prompt_index") - promptIndex: int32; + @doc("The role that provides function results for chat completions.") + @added(ServiceApiVersions.v2023_07_01_Preview) + function: "function", - @doc("Content filtering results for this prompt") - @projectedName("json", "content_filter_results") - contentFilterResults?: ContentFilterResults; + @doc("The role that represents extension tool activity within a chat completions operation.") + @added(ServiceApiVersions.v2023_08_01_Preview) + tool: "tool", } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp index 93dcb25733a7..690c3fdba6a2 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/completions_create.tsp @@ -3,6 +3,7 @@ import "@typespec/http"; import "@typespec/versioning"; import "./common.tsp"; +import "./azure_content_filtering.tsp"; using TypeSpec.Rest; using TypeSpec.Http; @@ -169,7 +170,7 @@ model Completions { """) @added(ServiceApiVersions.v2023_06_01_Preview) @projectedName("json", "prompt_filter_results") - promptFilterResults?: PromptFilterResult[]; + promptFilterResults?: ContentFilterResultsForPrompt[]; @doc(""" The collection of completions choices associated with this completions response. @@ -207,7 +208,7 @@ model Choice { """) @added(ServiceApiVersions.v2023_06_01_Preview) @projectedName("json", "content_filter_results") - contentFilterResults?: ContentFilterResults; + contentFilterResults?: ContentFilterResultsForChoice; #suppress "@azure-tools/typespec-azure-core/no-nullable" "The operation already returns nulls" @doc("The log probabilities model for tokens associated with this completions choice.") diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp new file mode 100644 index 000000000000..657a61bba75d --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/authentication.tsp @@ -0,0 +1,99 @@ +import "@typespec/versioning"; + +namespace Azure.OpenAI; + +using TypeSpec.Versioning; + +@doc(""" +The authentication types supported with Azure OpenAI On Your Data. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +enum OnYourDataAuthenticationType { + @doc("Authentication via API key.") + apiKey: "APIKey", + + @doc("Authentication via connection string.") + connectionString: "ConnectionString", + + @doc("Authentication via key and key ID pair.") + keyAndKeyId: "KeyAndKeyId", + + @doc("Authentication via system-assigned managed identity.") + systemAssignedManagedIdentity: "SystemAssignedManagedIdentity", + + @doc("Authentication via user-assigned managed identity.") + userAssignedManagedIdentity: "UserAssignedManagedIdentity", +} + +@discriminator("type") +@doc("The authentication options for Azure OpenAI On Your Data.") +@added(ServiceApiVersions.v2023_08_01_Preview) +model OnYourDataAuthenticationOptions { + @doc("The authentication type.") + type: OnYourDataAuthenticationType; +} + +@doc(""" +The authentication options for Azure OpenAI On Your Data when using an API key. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +model OnYourDataApiKeyAuthenticationOptions + extends OnYourDataAuthenticationOptions { + @doc("The authentication type of API key.") + type: OnYourDataAuthenticationType.apiKey; + + @doc("The API key to use for authentication.") + key: string; +} + +@doc(""" +The authentication options for Azure OpenAI On Your Data when using a connection string. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +model OnYourDataConnectionStringAuthenticationOptions + extends OnYourDataAuthenticationOptions { + @doc("The authentication type of connection string.") + type: OnYourDataAuthenticationType.connectionString; + + @doc("The connection string to use for authentication.") + connectionString: string; +} + +@doc(""" +The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +model OnYourDataKeyAndKeyIdAuthenticationOptions + extends OnYourDataAuthenticationOptions { + @doc("The authentication type of Elasticsearch key and key ID pair.") + type: OnYourDataAuthenticationType.keyAndKeyId; + + @doc("The key to use for authentication.") + key: string; + + @doc("The key ID to use for authentication.") + keyId: string; +} + +@doc(""" +The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +model OnYourDataSystemAssignedManagedIdentityAuthenticationOptions + extends OnYourDataAuthenticationOptions { + @doc("The authentication type of system-assigned managed identity.") + type: OnYourDataAuthenticationType.systemAssignedManagedIdentity; +} + +@doc(""" +The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +model OnYourDataUserAssignedManagedIdentityAuthenticationOptions + extends OnYourDataAuthenticationOptions { + @doc("The authentication type of user-assigned managed identity.") + type: OnYourDataAuthenticationType.userAssignedManagedIdentity; + + @doc("The resource ID of the user-assigned managed identity to use for authentication.") + managedIdentityResourceId: string; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp new file mode 100644 index 000000000000..8ef494030b21 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cognitive_search_options.tsp @@ -0,0 +1,125 @@ +import "@typespec/versioning"; +import "./../../azure_chat_extensions.tsp"; +import "./common_options.tsp"; +import "./vector_search.tsp"; + +namespace Azure.OpenAI; + +using TypeSpec.Versioning; + +@added(ServiceApiVersions.v2023_08_01_Preview) +@doc(""" +A specific representation of configurable options for Azure Cognitive Search when using it as an Azure OpenAI chat +extension. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +model AzureCognitiveSearchChatExtensionConfiguration + extends AzureChatExtensionConfiguration { + @doc(""" + The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its + default value for Azure Cognitive Search. + """) + type: AzureChatExtensionType.azureCognitiveSearch; + + @doc("The parameters to use when configuring Azure Cognitive Search.") + parameters: AzureCognitiveSearchChatExtensionParameters; +} + +@added(ServiceApiVersions.v2023_08_01_Preview) +@doc("Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.") +model AzureCognitiveSearchChatExtensionParameters { + ...OnYourDataCommonChatExtensionConfiguration; + + @doc("The absolute endpoint path for the Azure Cognitive Search resource to use.") + @projectedName("csharp", "SearchEndpoint") + endpoint: url; + + @doc("The name of the index to use as available in the referenced Azure Cognitive Search resource.") + indexName: string; + + @doc("The API key to use when interacting with the Azure Cognitive Search resource.") + @added(ServiceApiVersions.v2023_08_01_Preview) + @removed(ServiceApiVersions.v2023_12_01_Preview) + key?: string; + + @doc("Customized field mapping behavior to use when interacting with the search index.") + @projectedName("csharp", "FieldMappingOptions") + fieldsMapping?: AzureCognitiveSearchIndexFieldMappingOptions; + + @doc("The query type to use with Azure Cognitive Search.") + queryType?: AzureCognitiveSearchQueryType; + + @doc("The additional semantic configuration for the query.") + semanticConfiguration?: string; + + @doc("Search filter.") + filter?: string; + + @doc("When using embeddings for search, specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of format https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings?api-version={api-version}.") + @added(ServiceApiVersions.v2023_08_01_Preview) + @removed(ServiceApiVersions.v2023_12_01_Preview) + embeddingEndpoint?: url; + + @added(ServiceApiVersions.v2023_08_01_Preview) + @removed(ServiceApiVersions.v2023_12_01_Preview) + @doc("When using embeddings, specifies the API key to use with the provided embeddings endpoint.") + embeddingKey?: string; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("The embedding dependency for vector search.") + embeddingDependency?: OnYourDataVectorizationSource; +} + +@doc("Optional settings to control how fields are processed when using a configured Azure Cognitive Search resource.") +@added(ServiceApiVersions.v2023_08_01_Preview) +model AzureCognitiveSearchIndexFieldMappingOptions { + @doc("The name of the index field to use as a title.") + @projectedName("csharp", "TitleFieldName") + titleField?: string; + + @doc("The name of the index field to use as a URL.") + @projectedName("csharp", "UrlFieldName") + urlField?: string; + + @doc("The name of the index field to use as a filepath.") + @projectedName("csharp", "FilepathFieldName") + filepathField?: string; + + @doc("The names of index fields that should be treated as content.") + @projectedName("csharp", "ContentFieldNames") + contentFields?: string[]; + + @doc("The separator pattern that content fields should use.") + @projectedName("csharp", "ContentFieldSeparator") + contentFieldsSeparator?: string; + + @doc("The names of fields that represent vector data.") + @projectedName("csharp", "VectorFieldNames") + vectorFields?: string[]; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("The names of fields that represent image vector data.") + @projectedName("csharp", "ImageVectorFieldNames") + imageVectorFields?: string[]; +} + +@doc(""" +The type of Azure Cognitive Search retrieval query that should be executed when using it as an Azure OpenAI chat extension. +""") +@added(ServiceApiVersions.v2023_08_01_Preview) +enum AzureCognitiveSearchQueryType { + @doc("Represents the default, simple query parser.") + simple: "simple", + + @doc("Represents the semantic query parser for advanced semantic modeling.") + semantic: "semantic", + + @doc("Represents vector search over computed data.") + vector: "vector", + + @doc("Represents a combination of the simple query strategy with vector data.") + vectorSimpleHybrid: "vectorSimpleHybrid", + + @doc("Represents a combination of semantic search and vector data querying.") + vectorSemanticHybrid: "vectorSemanticHybrid", +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp new file mode 100644 index 000000000000..e169fc9dbfde --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_cosmosdb_options.tsp @@ -0,0 +1,64 @@ +import "@typespec/versioning"; +import "./../../azure_chat_extensions.tsp"; +import "./common_options.tsp"; +import "./vector_search.tsp"; + +namespace Azure.OpenAI; + +using TypeSpec.Versioning; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat +extension. +""") +model AzureCosmosDBChatExtensionConfiguration + extends AzureChatExtensionConfiguration { + @doc(""" + The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its + default value for Azure Cosmos DB. + """) + type: AzureChatExtensionType.azureCosmosDB; + + @doc("The parameters to use when configuring Azure OpenAI CosmosDB chat extensions.") + parameters: AzureCosmosDBChatExtensionParameters; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for +MongoDB vCore. +""") +model AzureCosmosDBChatExtensionParameters { + ...OnYourDataCommonChatExtensionConfiguration; + + @doc("The MongoDB vCore database name to use with Azure Cosmos DB.") + @projectedName("csharp", "DatabaseName") + databaseName: string; + + @doc("The name of the Azure Cosmos DB resource container.") + @projectedName("csharp", "ContainerName") + containerName: string; + + @doc("The MongoDB vCore index name to use with Azure Cosmos DB.") + @projectedName("csharp", "IndexName") + indexName: string; + + @doc("Customized field mapping behavior to use when interacting with the search index.") + @projectedName("csharp", "FieldMappingOptions") + fieldsMapping: AzureCosmosDBFieldMappingOptions; + + @doc("The embedding dependency for vector search.") + embeddingDependency?: OnYourDataVectorizationSource; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" +@doc("Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.") +@added(ServiceApiVersions.v2023_12_01_Preview) +model AzureCosmosDBFieldMappingOptions { + @doc("The names of fields that represent vector data.") + @projectedName("csharp", "VectorFieldNames") + vectorFields: string[]; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp new file mode 100644 index 000000000000..ae37887aac41 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/azure_machinelearning_index_options.tsp @@ -0,0 +1,46 @@ +import "@typespec/versioning"; +import "./../../azure_chat_extensions.tsp"; +import "./common_options.tsp"; + +namespace Azure.OpenAI; + +using TypeSpec.Versioning; + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +A specific representation of configurable options for Azure Machine Learning vector index when using it as an Azure +OpenAI chat extension. +""") +model AzureMachineLearningIndexChatExtensionConfiguration + extends AzureChatExtensionConfiguration { + @doc(""" + The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its + default value for Azure Machine Learning vector index. + """) + type: AzureChatExtensionType.azureMachineLearningIndex; + + @doc("The parameters for the Azure Machine Learning vector index chat extension.") + parameters: AzureMachineLearningIndexChatExtensionParameters; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("Parameters for the Azure Machine Learning vector index chat extension.") +model AzureMachineLearningIndexChatExtensionParameters { + ...OnYourDataCommonChatExtensionConfiguration; + + @doc("The resource ID of the Azure Machine Learning project.") + @projectedName("csharp", "ProjectResourceId") + projectResourceId: string; + + @doc("The Azure Machine Learning vector index name.") + @projectedName("csharp", "Name") + name: string; + + @doc("The version of the Azure Machine Learning vector index.") + @projectedName("csharp", "Version") + version: string; + + @doc("Search filter. Only supported if the Azure Machine Learning vector index is of type AzureSearch.") + @projectedName("csharp", "Filter") + filter?: string; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp new file mode 100644 index 000000000000..5184cd4e457a --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/common_options.tsp @@ -0,0 +1,36 @@ +import "@typespec/versioning"; +import "./../../azure_chat_extensions.tsp"; +import "./authentication.tsp"; + +namespace Azure.OpenAI; + +using TypeSpec.Versioning; + +alias OnYourDataCommonChatExtensionConfiguration = { + @doc(""" + The authentication method to use when accessing the defined data source. + Each data source type supports a specific set of available authentication methods; please see the documentation of + the data source for supported mechanisms. + If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) + authentication. + """) + @projectedName("csharp", "Authentication") + authentication?: OnYourDataAuthenticationOptions; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" + @doc("The configured top number of documents to feature for the configured query.") + @projectedName("csharp", "DocumentCount") + topNDocuments?: int32; + + @doc("Whether queries should be restricted to use of indexed data.") + @projectedName("csharp", "ShouldRestrictResultScope") + inScope?: boolean; + + @doc("The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.") + @minValue(1) + @maxValue(5) + strictness?: int32; + + @doc("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.") + roleInformation?: string; +}; diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp new file mode 100644 index 000000000000..fe691977fb69 --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/elasticsearch_options.tsp @@ -0,0 +1,86 @@ +import "@typespec/versioning"; +import "./../../azure_chat_extensions.tsp"; +import "./common_options.tsp"; + +namespace Azure.OpenAI; + +using TypeSpec.Versioning; + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat +extension. +""") +model ElasticsearchChatExtensionConfiguration + extends AzureChatExtensionConfiguration { + @doc(""" + The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its + default value for Elasticsearch®. + """) + type: AzureChatExtensionType.elasticsearch; + + @doc("The parameters to use when configuring Elasticsearch®.") + parameters: ElasticsearchChatExtensionParameters; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension.") +model ElasticsearchChatExtensionParameters { + ...OnYourDataCommonChatExtensionConfiguration; + + @doc("The endpoint of Elasticsearch®.") + endpoint: url; + + @doc("The index name of Elasticsearch®.") + indexName: string; + + @doc("The index field mapping options of Elasticsearch®.") + @projectedName("csharp", "FieldMappingOptions") + fieldsMapping?: ElasticsearchIndexFieldMappingOptions; + + @doc("The query type of Elasticsearch®.") + queryType?: ElasticsearchQueryType; + + @doc("The embedding dependency for vector search.") + embeddingDependency?: OnYourDataVectorizationSource; +} + +@doc("Optional settings to control how fields are processed when using a configured Elasticsearch® resource.") +@added(ServiceApiVersions.v2023_12_01_Preview) +model ElasticsearchIndexFieldMappingOptions { + @doc("The name of the index field to use as a title.") + @projectedName("csharp", "TitleFieldName") + titleField?: string; + + @doc("The name of the index field to use as a URL.") + @projectedName("csharp", "UrlFieldName") + urlField?: string; + + @doc("The name of the index field to use as a filepath.") + @projectedName("csharp", "FilepathFieldName") + filepathField?: string; + + @doc("The names of index fields that should be treated as content.") + @projectedName("csharp", "ContentFieldNames") + contentFields?: string[]; + + @doc("The separator pattern that content fields should use.") + @projectedName("csharp", "ContentFieldSeparator") + contentFieldsSeparator?: string; + + @doc("The names of fields that represent vector data.") + @projectedName("csharp", "VectorFieldNames") + vectorFields?: string[]; +} + +@doc(""" +The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension. +""") +@added(ServiceApiVersions.v2023_12_01_Preview) +enum ElasticsearchQueryType { + @doc("Represents the default, simple query parser.") + simple: "simple", + + @doc("Represents vector search over computed data.") + vector: "vector", +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp new file mode 100644 index 000000000000..dc1096b96fda --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/pinecone_options.tsp @@ -0,0 +1,79 @@ +import "@typespec/versioning"; +import "./../../azure_chat_extensions.tsp"; +import "./common_options.tsp"; +import "./vector_search.tsp"; + +namespace Azure.OpenAI; + +using TypeSpec.Versioning; + +#suppress "@azure-tools/typespec-azure-core/casing-style" "this represents the case-sensitive wire format" +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat +extension. +""") +model PineconeChatExtensionConfiguration + extends AzureChatExtensionConfiguration { + @doc(""" + The type label to use when configuring Azure OpenAI chat extensions. This should typically not be changed from its + default value for Pinecone. + """) + type: AzureChatExtensionType.pinecone; + + @doc("The parameters to use when configuring Azure OpenAI chat extensions.") + parameters: PineconeChatExtensionParameters; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("Parameters for configuring Azure OpenAI Pinecone chat extensions.") +model PineconeChatExtensionParameters { + ...OnYourDataCommonChatExtensionConfiguration; + + @doc("The environment name of Pinecone.") + @projectedName("csharp", "EnvironmentName") + environment: string; + + @doc("The name of the Pinecone database index.") + indexName: string; + + @doc("Customized field mapping behavior to use when interacting with the search index.") + @projectedName("csharp", "FieldMappingOptions") + fieldsMapping: PineconeFieldMappingOptions; + + @doc("The embedding dependency for vector search.") + embeddingDependency?: OnYourDataVectorizationSource; +} + +@doc("Optional settings to control how fields are processed when using a configured Pinecone resource.") +@added(ServiceApiVersions.v2023_08_01_Preview) +model PineconeFieldMappingOptions { + @doc("The name of the index field to use as a title.") + @projectedName("csharp", "TitleFieldName") + titleField?: string; + + @doc("The name of the index field to use as a URL.") + @projectedName("csharp", "UrlFieldName") + urlField?: string; + + @doc("The name of the index field to use as a filepath.") + @projectedName("csharp", "FilepathFieldName") + filepathField?: string; + + @doc("The names of index fields that should be treated as content.") + @projectedName("csharp", "ContentFieldNames") + contentFields?: string[]; + + @doc("The separator pattern that content fields should use.") + @projectedName("csharp", "ContentFieldSeparator") + contentFieldsSeparator?: string; + + @doc("The names of fields that represent vector data.") + @projectedName("csharp", "VectorFieldNames") + vectorFields?: string[]; + + @added(ServiceApiVersions.v2023_12_01_Preview) + @doc("The names of fields that represent image vector data.") + @projectedName("csharp", "ImageVectorFieldNames") + imageVectorFields?: string[]; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp new file mode 100644 index 000000000000..7136d8f1f62b --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/extensions/oyd/vector_search.tsp @@ -0,0 +1,84 @@ +import "@typespec/versioning"; +import "./authentication.tsp"; + +namespace Azure.OpenAI; + +using TypeSpec.Versioning; + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with +vector search. +""") +enum OnYourDataVectorizationSourceType { + @doc(""" + Represents vectorization performed by public service calls to an Azure OpenAI embedding model. + """) + endpoint: "Endpoint", + + @doc(""" + Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but + On Your Data will use this model deployment via an internal call rather than a public one, which enables vector + search even in private networks. + """) + deploymentName: "DeploymentName", + + @doc(""" + Represents a specific embedding model ID as defined in the search service. + Currently only supported by Elasticsearch®. + """) + modelId: "ModelId", +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@discriminator("type") +@doc("An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search.") +model OnYourDataVectorizationSource { + @doc("The type of vectorization source to use.") + type: OnYourDataVectorizationSourceType; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based +on a public Azure OpenAI endpoint call for embeddings. +""") +model OnYourDataEndpointVectorizationSource + extends OnYourDataVectorizationSource { + @doc("The type of vectorization source to use. Always 'Endpoint' for this type.") + type: OnYourDataVectorizationSourceType.endpoint; + + @doc("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.") + endpoint: url; + + @doc("Specifies the authentication options to use when retrieving embeddings from the specified endpoint.") + authentication: OnYourDataAuthenticationOptions; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based +on an internal embeddings model deployment name in the same Azure OpenAI resource. +""") +model OnYourDataDeploymentNameVectorizationSource + extends OnYourDataVectorizationSource { + @doc("The type of vectorization source to use. Always 'DeploymentName' for this type.") + type: OnYourDataVectorizationSourceType.deploymentName; + + @doc("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.") + deploymentName: string; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based +on a search service model ID. Currently only supported by Elasticsearch®. +""") +model OnYourDataModelIdVectorizationSource + extends OnYourDataVectorizationSource { + @doc("The type of vectorization source to use. Always 'ModelId' for this type.") + type: OnYourDataVectorizationSourceType.modelId; + + @doc("The embedding model ID build inside the search service. Currently only supported by Elasticsearch®.") + modelId: string; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/functions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/functions.tsp index 00724300da8f..7f33c7ae24af 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/functions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/functions.tsp @@ -51,7 +51,7 @@ model FunctionDefinition { description?: string; #suppress "@azure-tools/typespec-azure-core/no-unknown" "External API shape takes an arbitrary json" - @doc("The parameters the functions accepts, described as a JSON Schema object.") + @doc("The parameters the function accepts, described as a JSON Schema object.") parameters?: unknown; } diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp new file mode 100644 index 000000000000..b1c82e82b33f --- /dev/null +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/tools.tsp @@ -0,0 +1,97 @@ +import "@typespec/versioning"; +import "./functions.tsp"; + +namespace Azure.OpenAI; + +using TypeSpec.Versioning; + +// tool_choice: "auto" | "none" | { "type": "function", "name": string } + +#suppress "@azure-tools/typespec-autorest/union-unsupported" "External API shape is defined in OpenAPI 3.0 as oneOf." +alias ChatCompletionsToolSelection = ChatCompletionsToolSelectionPreset | ChatCompletionsNamedToolSelection; + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("Represents a generic policy for how a chat completions tool may be selected.") +enum ChatCompletionsToolSelectionPreset { + @doc(""" + Specifies that the model may either use any of the tools provided in this chat completions request or + instead return a standard chat completions response as if no tools were provided. + """) + auto: "auto", + + @doc(""" + Specifies that the model should not respond with a tool call and should instead provide a standard chat + completions response. Response content may still be influenced by the provided tool definitions. + """) + none: "none", +} + +@discriminator("type") +@doc("An abstract representation of an explicit, named tool selection to use for a chat completions request.") +model ChatCompletionsNamedToolSelection { + @doc("The object type.") + type: string; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc("A tool selection of a specific, named function tool that will limit chat completions to using the named function.") +model ChatCompletionsNamedFunctionToolSelection + extends ChatCompletionsNamedToolSelection { + @doc("The object type, which is always 'function'.") + type: "function"; + + @doc("The name of the function that should be called.") + name: "string"; +} + +// tool definitions: provided in the request options + +@discriminator("type") +@doc("An abstract representation of a tool that can be used by the model to improve a chat completions response.") +@added(ServiceApiVersions.v2023_12_01_Preview) +model ChatCompletionsToolDefinition { + @doc("The object type.") + type: string; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +The definition information for a chat completions function tool that can call a function in response to a tool call. +""") +model ChatCompletionsFunctionToolDefinition + extends ChatCompletionsToolDefinition { + @doc("The object name, which is always 'function'.") + type: "function"; + + @doc("The function definition details for the function tool.") + function: FunctionDefinition; +} + +// tool calls: received in responses + +@discriminator("type") +@doc(""" +An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested +chat completion. +""") +@added(ServiceApiVersions.v2023_12_01_Preview) +model ChatCompletionsToolCall { + @doc("The object type.") + type: string; + + @doc("The ID of the tool call.") + id: string; +} + +@added(ServiceApiVersions.v2023_12_01_Preview) +@doc(""" +A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents +a function invocation needed for a subsequent chat completions request to resolve. +""") +model ChatCompletionsFunctionToolCall extends ChatCompletionsToolCall { + @doc("The type of tool call, in this case always 'function'.") + type: "function"; + + @doc("The details of the function invocation requested by the tool call.") + function: FunctionCall; +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/images/common.tsp b/specification/cognitiveservices/OpenAI.Inference/models/images/common.tsp index f5adeaaa1916..e83ed5132c43 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/images/common.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/images/common.tsp @@ -1,13 +1,16 @@ import "@azure-tools/typespec-azure-core"; import "@typespec/http"; +import "@typespec/versioning"; using Azure.Core; using TypeSpec.Http; +using TypeSpec.Versioning; namespace Azure.OpenAI; @lroStatus @doc("The state of a job or item.") +@removed(ServiceApiVersions.v2023_12_01_Preview) enum AzureOpenAIOperationState { @doc("The operation was created and is queued to be processed in the future.") notRunning, @@ -32,6 +35,7 @@ enum AzureOpenAIOperationState { @Foundations.Private.needsRoute @post @doc("Long running operation template to match Azure OpenAI .") +@removed(ServiceApiVersions.v2023_12_01_Preview) op OaiLongRunningRpcOperation< TParams extends TypeSpec.Reflection.Model, TResponse extends TypeSpec.Reflection.Model, diff --git a/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp b/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp index 7542dce12326..a80a53300efd 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/images/images.tsp @@ -10,88 +10,188 @@ using TypeSpec.Versioning; namespace Azure.OpenAI; -@doc("The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.") +@doc("The desired size of generated images.") @added(ServiceApiVersions.v2023_06_01_Preview) enum ImageSize { - @doc("Image size of 256x256.") - Size256x256: "256x256", + @doc(""" + Very small image size of 256x256 pixels. + Only supported with dall-e-2 models. + """) + size256x256: "256x256", + + @doc(""" + A smaller image size of 512x512 pixels. + Only supported with dall-e-2 models. + """) + size512x512: "512x512", + + @doc(""" + A standard, square image size of 1024x1024 pixels. + Supported by both dall-e-2 and dall-e-3 models. + """) + @added(ServiceApiVersions.v2023_12_01_Preview) + size1024x1024: "1024x1024", + + @doc(""" + A wider image size of 1024x1792 pixels. + Only supported with dall-e-3 models. + """) + @added(ServiceApiVersions.v2023_12_01_Preview) + size1792x1024: "1792x1024", + + @doc(""" + A taller image size of 1792x1024 pixels. + Only supported with dall-e-3 models. + """) + @added(ServiceApiVersions.v2023_12_01_Preview) + size1024x1792: "1024x1792", +} + +@doc(""" +An image generation configuration that specifies how the model should prioritize quality, cost, and speed. +Only configurable with dall-e-3 models. +""") +@added(ServiceApiVersions.v2023_12_01_Preview) +enum ImageGenerationQuality { + @doc(""" + Requests image generation with standard, balanced characteristics of quality, cost, and speed. + """) + standard: "standard", - @doc("Image size of 512x512.") - Size512x512: "512x512", + @doc(""" + Requests image generation with higher quality, higher cost and lower speed relative to standard. + """) + hd: "hd", +} + +@doc(""" +An image generation configuration that specifies how the model should incorporate realism and other visual characteristics. +Only configurable with dall-e-3 models. +""") +@added(ServiceApiVersions.v2023_12_01_Preview) +enum ImageGenerationStyle { + @doc(""" + Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics. + """) + natural: "natural", - @doc("Image size of 1024x1024.") - Size1024x1024: "1024x1024", + @doc(""" + Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic + characteristics. + """) + vivid: "vivid", } @doc("The format in which the generated images are returned.") @added(ServiceApiVersions.v2023_06_01_Preview) enum ImageGenerationResponseFormat { @doc("Image generation response items should provide a URL from which the image may be retrieved.") - Url: "url", + url: "url", @doc("Image generation response items should provide image data as a base64-encoded string.") - Base64: "b64_json", + base64: "b64_json", } @doc("Represents the request data used to generate images.") @added(ServiceApiVersions.v2023_06_01_Preview) model ImageGenerationOptions { + @doc(""" + The model name or Azure OpenAI model deployment name to use for image generation. If not specified, dall-e-2 will be + inferred as a default. + """) + `model`?: string; + @doc("A description of the desired images.") prompt: string; - @doc("The number of images to generate (defaults to 1).") + @doc(""" + The number of images to generate. + Dall-e-2 models support values between 1 and 10. + Dall-e-3 models only support a value of 1. + """) @projectedName("csharp", "ImageCount") n?: int32 = 1; - @doc("The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 (defaults to 1024x1024).") - size?: ImageSize = ImageSize.Size1024x1024; - @doc(""" - The format in which image generation response items should be presented. - Azure OpenAI only supports URL response items. + The desired dimensions for generated images. + Dall-e-2 models support 256x256, 512x512, or 1024x1024. + Dall-e-3 models support 1024x1024, 1792x1024, or 1024x1792. """) + size?: ImageSize = ImageSize.size1024x1024; + + @doc("The format in which image generation response items should be presented.") @projectedName("json", "response_format") - responseFormat?: ImageGenerationResponseFormat; + responseFormat?: ImageGenerationResponseFormat = ImageGenerationResponseFormat.url; + + @doc(""" + The desired image generation quality level to use. + Only configurable with dall-e-3 models. + """) + @added(ServiceApiVersions.v2023_12_01_Preview) + quality?: ImageGenerationQuality = ImageGenerationQuality.standard; + + @doc(""" + The desired image generation style to use. + Only configurable with dall-e-3 models. + """) + @added(ServiceApiVersions.v2023_12_01_Preview) + style?: ImageGenerationStyle = ImageGenerationStyle.vivid; @doc("A unique identifier representing your end-user, which can help to monitor and detect abuse.") user?: string; } -@doc("An image response item that provides a URL from which an image may be accessed.") +@doc(""" +A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image +may be retrieved. +""") @added(ServiceApiVersions.v2023_06_01_Preview) -model ImageLocation { +model ImageGenerationData { @doc("The URL that provides temporary access to download the generated image.") - url: url; -} + url?: url; -@doc("An image response item that directly represents the image data as a base64-encoded string.") -@added(ServiceApiVersions.v2023_06_01_Preview) -model ImagePayload { - @doc("The complete data for an image represented as a base64-encoded string.") + @doc("The complete data for an image, represented as a base64-encoded string.") @projectedName("json", "b64_json") - base64Data: string; + base64Data?: string; + + @doc(""" + The final prompt used by the model to generate the image. + Only provided with dall-3-models and only when revisions were made to the prompt. + """) + @added(ServiceApiVersions.v2023_12_01_Preview) + @projectedName("json", "revised_prompt") + revisedPrompt?: string; } -@doc("The result of the operation if the operation succeeded.") +@doc("The result of a successful image generation operation.") @added(ServiceApiVersions.v2023_06_01_Preview) model ImageGenerations { - @doc("A timestamp when this job or item was created (in unix epochs).") + @doc(""" + A timestamp representing when this operation was started. + Expressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000. + """) @projectedName("json", "created") @projectedName("java", "createdAt") @encode(DateTimeKnownEncoding.unixTimestamp, int32) created: utcDateTime; - #suppress "@azure-tools/typespec-autorest/union-unsupported" "openapi v2 not required" - @doc("The images generated by the operator.") - data: ImageLocation[] | ImagePayload[]; + @doc("The images generated by the operation.") + data: ImageGenerationData[]; } // Note: pending resolution of cross-language code emission behavior for long-running operations, image generation // reuses its final operation response model as its status polling model. -// @lroStatus +// Note2: the Java emitter currently does not support versioning annotations +// To prevent code generation from picking this up we have to flat out remove it +// We need to check in an arch board meeting, whether @removed indeed should prevent +// models from being generated. It might not be the case, it should probably enforce a "maximum" +// version, but not prevent generation of models for older versions. + +//@lroStatus @doc("A polling status update or final response payload for an image operation.") @added(ServiceApiVersions.v2023_06_01_Preview) +@removed(ServiceApiVersions.v2023_12_01_Preview) model BatchImageGenerationOperationResponse { @doc("The ID of the operation.") id: string; diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/common.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/common.tsp index 693140124eee..ba5bd9aa0fca 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/common.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/common.tsp @@ -1,12 +1,8 @@ import "@typespec/rest"; import "@typespec/http"; -// import "@typespec/versioning"; - -// import "./routes.tsp"; using TypeSpec.Http; using TypeSpec.Rest; -// using TypeSpec.Versioning; @doc("A specific deployment") @TypeSpec.Rest.resource("deployments") diff --git a/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp b/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp index b1f0f1a5de96..f7f5026db413 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes/images.tsp @@ -14,13 +14,26 @@ using Azure.Core; namespace Azure.OpenAI; -// Note: pending resolution of cross-language code emission behavior for long-running operations, image generation +@doc("Creates an image given a prompt.") +@added(ServiceApiVersions.v2023_12_01_Preview) +@actionSeparator("/") +@action("images/generations") +op getImageGenerations is Azure.Core.ResourceAction< + Deployment, + ImageGenerationOptions, + ImageGenerations +>; + +// Note: pending resolution of cross-language code emission behavior for long-running operations, image generation // reuses its final operation response model as its status polling model. +// Note2: see the comments in the models/images/images.tsp file for more information on why the op is commented out + #suppress "@azure-tools/typespec-azure-core/rpc-operation-request-body" "MUST fix in next update" #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Allowed because this is a non-standard status polling operation." @doc("Returns the status of the images operation") @added(ServiceApiVersions.v2023_06_01_Preview) +@removed(ServiceApiVersions.v2023_12_01_Preview) @route("/operations/images/{operationId}") op getAzureBatchImageGenerationOperationStatus is RpcOperation< { @@ -32,6 +45,7 @@ op getAzureBatchImageGenerationOperationStatus is RpcOperation< #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "" @doc("Starts the generation of a batch of images from a text caption") @added(ServiceApiVersions.v2023_06_01_Preview) +@removed(ServiceApiVersions.v2023_12_01_Preview) @route("/images/generations:submit") @pollingOperation( getAzureBatchImageGenerationOperationStatus, diff --git a/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml b/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml index 14c4aa0dd5f4..7bbe1b2e03b4 100644 --- a/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml +++ b/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml @@ -20,6 +20,7 @@ options: namespace: "Azure.AI.OpenAI" clear-output-folder: true model-namespace: false + generate-protocol-methods: false "@azure-tools/typespec-java": package-dir: "azure-ai-openai" namespace: "com.azure.ai.openai" @@ -28,6 +29,7 @@ options: generate-tests: false custom-types-subpackage: "implementation.models" custom-types: "FunctionCallPreset" + customization-class: customization/src/main/java/ChatCompletionsToolCallCustomizations.java "@azure-tools/typespec-ts": package-dir: "openai" generateMetadata: false 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 0a5686339dbe..22f163ead36b 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 @@ -454,7 +454,7 @@ "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "message": { - "$ref": "#/definitions/ChatMessage", + "$ref": "#/definitions/ChatResponseMessage", "description": "The chat message for a given chat completions prompt." }, "index": { @@ -469,11 +469,11 @@ "x-ms-client-name": "finishReason" }, "delta": { - "$ref": "#/definitions/ChatMessage", + "$ref": "#/definitions/ChatResponseMessage", "description": "The delta message content for a streaming response." }, "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", + "$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" } @@ -508,7 +508,7 @@ "type": "array", "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", "items": { - "$ref": "#/definitions/PromptFilterResult" + "$ref": "#/definitions/ContentFilterResultsForPrompt" }, "x-ms-client-name": "promptFilterResults", "x-ms-identifiers": [] @@ -533,7 +533,7 @@ "type": "array", "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", "items": { - "$ref": "#/definitions/ChatMessage" + "$ref": "#/definitions/ChatRequestMessage" }, "x-ms-identifiers": [] }, @@ -604,17 +604,100 @@ "messages" ] }, - "ChatMessage": { + "ChatRequestAssistantMessage": { "type": "object", - "description": "A single, role-attributed message within a chat completion interaction.", + "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." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "assistant" + }, + "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 role associated with this message payload." + "description": "The chat role associated with the message." }, "content": { "type": "string", - "description": "The text associated with this message payload.", + "description": "The content of the message.", "x-nullable": true } }, @@ -667,7 +750,7 @@ "description": "The ordered index associated with this completions choice." }, "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", + "$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" }, @@ -712,7 +795,7 @@ "type": "array", "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", "items": { - "$ref": "#/definitions/PromptFilterResult" + "$ref": "#/definitions/ContentFilterResultsForPrompt" }, "x-ms-client-name": "promptFilterResults", "x-ms-identifiers": [] @@ -959,9 +1042,36 @@ "filtered" ] }, - "ContentFilterResults": { + "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 the content filtering category, if it has been detected.", + "description": "Information about content filtering evaluated against generated model output.", "properties": { "sexual": { "$ref": "#/definitions/ContentFilterResult", @@ -986,6 +1096,27 @@ } } }, + "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.", @@ -1113,10 +1244,30 @@ "total_tokens" ] }, + "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." @@ -1124,17 +1275,18 @@ "n": { "type": "integer", "format": "int32", - "description": "The number of images to generate (defaults to 1).", + "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": { "$ref": "#/definitions/ImageSize", - "description": "The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 (defaults to 1024x1024).", + "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" }, "response_format": { "$ref": "#/definitions/ImageGenerationResponseFormat", - "description": " The format in which image generation response items should be presented.\n Azure OpenAI only supports URL response items.", + "description": "The format in which image generation response items should be presented.", + "default": "url", "x-ms-client-name": "responseFormat" }, "user": { @@ -1158,12 +1310,12 @@ "modelAsString": true, "values": [ { - "name": "Url", + "name": "url", "value": "url", "description": "Image generation response items should provide a URL from which the image may be retrieved." }, { - "name": "Base64", + "name": "base64", "value": "b64_json", "description": "Image generation response items should provide image data as a base64-encoded string." } @@ -1172,15 +1324,20 @@ }, "ImageGenerations": { "type": "object", - "description": "The result of the operation if the operation succeeded.", + "description": "The result of a successful image generation operation.", "properties": { "created": { "type": "integer", "format": "unixtime", - "description": "A timestamp when this job or item was created (in unix epochs)." + "description": "A timestamp representing when this operation was started.\nExpressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000." }, "data": { - "description": "The images generated by the operator." + "type": "array", + "description": "The images generated by the operation.", + "items": { + "$ref": "#/definitions/ImageGenerationData" + }, + "x-ms-identifiers": [] } }, "required": [ @@ -1190,53 +1347,27 @@ }, "ImageSize": { "type": "string", - "description": "The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.", + "description": "The desired size of generated images.", "enum": [ "256x256", - "512x512", - "1024x1024" + "512x512" ], "x-ms-enum": { "name": "ImageSize", "modelAsString": true, "values": [ { - "name": "Size256x256", + "name": "size256x256", "value": "256x256", - "description": "Image size of 256x256." + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." }, { - "name": "Size512x512", + "name": "size512x512", "value": "512x512", - "description": "Image size of 512x512." - }, - { - "name": "Size1024x1024", - "value": "1024x1024", - "description": "Image size of 1024x1024." + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." } ] } - }, - "PromptFilterResult": { - "type": "object", - "description": "Content filtering results for a single prompt in the request.", - "properties": { - "prompt_index": { - "type": "integer", - "format": "int32", - "description": "The index of this prompt in the set of prompt results", - "x-ms-client-name": "promptIndex" - }, - "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", - "description": "Content filtering results for this prompt", - "x-ms-client-name": "contentFilterResults" - } - }, - "required": [ - "prompt_index" - ] } }, "parameters": { 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 86c41bc821ef..e27eaa74284b 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 @@ -454,7 +454,7 @@ "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "message": { - "$ref": "#/definitions/ChatMessage", + "$ref": "#/definitions/ChatResponseMessage", "description": "The chat message for a given chat completions prompt." }, "index": { @@ -469,11 +469,11 @@ "x-ms-client-name": "finishReason" }, "delta": { - "$ref": "#/definitions/ChatMessage", + "$ref": "#/definitions/ChatResponseMessage", "description": "The delta message content for a streaming response." }, "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", + "$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" } @@ -508,7 +508,7 @@ "type": "array", "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", "items": { - "$ref": "#/definitions/PromptFilterResult" + "$ref": "#/definitions/ContentFilterResultsForPrompt" }, "x-ms-client-name": "promptFilterResults", "x-ms-identifiers": [] @@ -533,7 +533,7 @@ "type": "array", "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", "items": { - "$ref": "#/definitions/ChatMessage" + "$ref": "#/definitions/ChatRequestMessage" }, "x-ms-identifiers": [] }, @@ -616,26 +616,135 @@ "messages" ] }, - "ChatMessage": { + "ChatRequestAssistantMessage": { "type": "object", - "description": "A single, role-attributed message within a chat completion interaction.", + "description": "A request chat message representing response or action from the assistant.", "properties": { - "role": { - "$ref": "#/definitions/ChatRole", - "description": "The role associated with this message payload." + "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 text associated with this message payload.", + "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": "The name of the author of this message. `name` is required if role is `function`, and it should be the name of the\nfunction whose response is in the `content`. May contain a-z, A-Z, 0-9, and underscores, with a maximum length of\n64 characters." + "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 name and arguments of a function that should be called, as generated by the model.", + "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" } }, @@ -694,7 +803,7 @@ "description": "The ordered index associated with this completions choice." }, "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", + "$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" }, @@ -739,7 +848,7 @@ "type": "array", "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", "items": { - "$ref": "#/definitions/PromptFilterResult" + "$ref": "#/definitions/ContentFilterResultsForPrompt" }, "x-ms-client-name": "promptFilterResults", "x-ms-identifiers": [] @@ -992,9 +1101,9 @@ "filtered" ] }, - "ContentFilterResults": { + "ContentFilterResultDetailsForPrompt": { "type": "object", - "description": "Information about the content filtering category, if it has been detected.", + "description": "Information about content filtering evaluated against input data to Azure OpenAI.", "properties": { "sexual": { "$ref": "#/definitions/ContentFilterResult", @@ -1019,6 +1128,54 @@ } } }, + "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.", @@ -1177,17 +1334,37 @@ "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 functions accepts, described as a JSON Schema object." + "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." @@ -1195,17 +1372,18 @@ "n": { "type": "integer", "format": "int32", - "description": "The number of images to generate (defaults to 1).", + "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": { "$ref": "#/definitions/ImageSize", - "description": "The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 (defaults to 1024x1024).", + "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" }, "response_format": { "$ref": "#/definitions/ImageGenerationResponseFormat", - "description": " The format in which image generation response items should be presented.\n Azure OpenAI only supports URL response items.", + "description": "The format in which image generation response items should be presented.", + "default": "url", "x-ms-client-name": "responseFormat" }, "user": { @@ -1229,12 +1407,12 @@ "modelAsString": true, "values": [ { - "name": "Url", + "name": "url", "value": "url", "description": "Image generation response items should provide a URL from which the image may be retrieved." }, { - "name": "Base64", + "name": "base64", "value": "b64_json", "description": "Image generation response items should provide image data as a base64-encoded string." } @@ -1243,15 +1421,20 @@ }, "ImageGenerations": { "type": "object", - "description": "The result of the operation if the operation succeeded.", + "description": "The result of a successful image generation operation.", "properties": { "created": { "type": "integer", "format": "unixtime", - "description": "A timestamp when this job or item was created (in unix epochs)." + "description": "A timestamp representing when this operation was started.\nExpressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000." }, "data": { - "description": "The images generated by the operator." + "type": "array", + "description": "The images generated by the operation.", + "items": { + "$ref": "#/definitions/ImageGenerationData" + }, + "x-ms-identifiers": [] } }, "required": [ @@ -1261,53 +1444,27 @@ }, "ImageSize": { "type": "string", - "description": "The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.", + "description": "The desired size of generated images.", "enum": [ "256x256", - "512x512", - "1024x1024" + "512x512" ], "x-ms-enum": { "name": "ImageSize", "modelAsString": true, "values": [ { - "name": "Size256x256", + "name": "size256x256", "value": "256x256", - "description": "Image size of 256x256." + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." }, { - "name": "Size512x512", + "name": "size512x512", "value": "512x512", - "description": "Image size of 512x512." - }, - { - "name": "Size1024x1024", - "value": "1024x1024", - "description": "Image size of 1024x1024." + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." } ] } - }, - "PromptFilterResult": { - "type": "object", - "description": "Content filtering results for a single prompt in the request.", - "properties": { - "prompt_index": { - "type": "integer", - "format": "int32", - "description": "The index of this prompt in the set of prompt results", - "x-ms-client-name": "promptIndex" - }, - "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", - "description": "Content filtering results for this prompt", - "x-ms-client-name": "contentFilterResults" - } - }, - "required": [ - "prompt_index" - ] } }, "parameters": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json index 7ef06b6abcab..808d4193b987 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-08-01-preview/generated.json @@ -428,14 +428,11 @@ "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." - }, - "parameters": { - "description": " The configuration payload used for the Azure chat extension. The structure payload details are specific to the\n extension being configured.\n Azure chat extensions are only compatible with Azure OpenAI." } }, + "discriminator": "type", "required": [ - "type", - "parameters" + "type" ] }, "AzureChatExtensionType": { @@ -464,12 +461,181 @@ "type": "array", "description": " The contextual message payload 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/ChatMessage" + "$ref": "#/definitions/ChatResponseMessage" }, "x-ms-identifiers": [] } } }, + "AzureCognitiveSearchChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Azure Cognitive Search when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/AzureCognitiveSearchChatExtensionParameters", + "description": "The parameters to use when configuring Azure Cognitive Search." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "AzureCognitiveSearch" + }, + "AzureCognitiveSearchChatExtensionParameters": { + "type": "object", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.", + "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." + }, + "topNDocuments": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query." + }, + "inScope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "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 + }, + "roleInformation": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "endpoint": { + "type": "string", + "format": "uri", + "description": "The absolute endpoint path for the Azure Cognitive Search resource to use." + }, + "indexName": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Cognitive Search resource." + }, + "key": { + "type": "string", + "description": "The API key to use when interacting with the Azure Cognitive Search resource." + }, + "fieldsMapping": { + "$ref": "#/definitions/AzureCognitiveSearchIndexFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index." + }, + "queryType": { + "$ref": "#/definitions/AzureCognitiveSearchQueryType", + "description": "The query type to use with Azure Cognitive Search." + }, + "semanticConfiguration": { + "type": "string", + "description": "The additional semantic configuration for the query." + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embeddingEndpoint": { + "type": "string", + "format": "uri", + "description": "When using embeddings for search, specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of format https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings?api-version={api-version}." + }, + "embeddingKey": { + "type": "string", + "description": "When using embeddings, specifies the API key to use with the provided embeddings endpoint." + } + }, + "required": [ + "endpoint", + "indexName" + ] + }, + "AzureCognitiveSearchIndexFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Azure Cognitive Search resource.", + "properties": { + "titleField": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "urlField": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepathField": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "contentFields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "contentFieldsSeparator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vectorFields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + } + }, + "AzureCognitiveSearchQueryType": { + "type": "string", + "description": "The type of Azure Cognitive Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "semantic", + "vector", + "vectorSimpleHybrid", + "vectorSemanticHybrid" + ], + "x-ms-enum": { + "name": "AzureCognitiveSearchQueryType", + "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": "vectorSimpleHybrid", + "description": "Represents a combination of the simple query strategy with vector data." + }, + { + "name": "vectorSemanticHybrid", + "value": "vectorSemanticHybrid", + "description": "Represents a combination of semantic search and vector data querying." + } + ] + } + }, "AzureOpenAIOperationState": { "type": "string", "description": "The state of a job or item.", @@ -554,7 +720,7 @@ "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "message": { - "$ref": "#/definitions/ChatMessage", + "$ref": "#/definitions/ChatResponseMessage", "description": "The chat message for a given chat completions prompt." }, "index": { @@ -569,11 +735,11 @@ "x-ms-client-name": "finishReason" }, "delta": { - "$ref": "#/definitions/ChatMessage", + "$ref": "#/definitions/ChatResponseMessage", "description": "The delta message content for a streaming response." }, "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", + "$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" } @@ -608,7 +774,7 @@ "type": "array", "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", "items": { - "$ref": "#/definitions/PromptFilterResult" + "$ref": "#/definitions/ContentFilterResultsForPrompt" }, "x-ms-client-name": "promptFilterResults", "x-ms-identifiers": [] @@ -633,7 +799,7 @@ "type": "array", "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", "items": { - "$ref": "#/definitions/ChatMessage" + "$ref": "#/definitions/ChatRequestMessage" }, "x-ms-identifiers": [] }, @@ -724,31 +890,140 @@ "messages" ] }, - "ChatMessage": { + "ChatRequestAssistantMessage": { "type": "object", - "description": "A single, role-attributed message within a chat completion interaction.", + "description": "A request chat message representing response or action from the assistant.", "properties": { - "role": { - "$ref": "#/definitions/ChatRole", - "description": "The role associated with this message payload." + "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 text associated with this message payload.", + "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": "The name of the author of this message. `name` is required if role is `function`, and it should be the name of the\nfunction whose response is in the `content`. May contain a-z, A-Z, 0-9, and underscores, with a maximum length of\n64 characters." + "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 name and arguments of a function that should be called, as generated by the model.", + "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": " Additional context data associated with a chat message when requesting chat completions using compatible Azure\n OpenAI chat extensions. This includes information like the intermediate data source retrievals used to service a\n request.\n This context information is only populated when using Azure OpenAI with chat extensions capabilities configured." + "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": [ @@ -812,7 +1087,7 @@ "description": "The ordered index associated with this completions choice." }, "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", + "$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" }, @@ -857,7 +1132,7 @@ "type": "array", "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", "items": { - "$ref": "#/definitions/PromptFilterResult" + "$ref": "#/definitions/ContentFilterResultsForPrompt" }, "x-ms-client-name": "promptFilterResults", "x-ms-identifiers": [] @@ -1110,9 +1385,36 @@ "filtered" ] }, - "ContentFilterResults": { + "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 the content filtering category, if it has been detected.", + "description": "Information about content filtering evaluated against generated model output.", "properties": { "sexual": { "$ref": "#/definitions/ContentFilterResult", @@ -1137,6 +1439,27 @@ } } }, + "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.", @@ -1295,17 +1618,37 @@ "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 functions accepts, described as a JSON Schema object." + "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." @@ -1313,17 +1656,18 @@ "n": { "type": "integer", "format": "int32", - "description": "The number of images to generate (defaults to 1).", + "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": { "$ref": "#/definitions/ImageSize", - "description": "The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 (defaults to 1024x1024).", + "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" }, "response_format": { "$ref": "#/definitions/ImageGenerationResponseFormat", - "description": " The format in which image generation response items should be presented.\n Azure OpenAI only supports URL response items.", + "description": "The format in which image generation response items should be presented.", + "default": "url", "x-ms-client-name": "responseFormat" }, "user": { @@ -1347,12 +1691,12 @@ "modelAsString": true, "values": [ { - "name": "Url", + "name": "url", "value": "url", "description": "Image generation response items should provide a URL from which the image may be retrieved." }, { - "name": "Base64", + "name": "base64", "value": "b64_json", "description": "Image generation response items should provide image data as a base64-encoded string." } @@ -1361,15 +1705,20 @@ }, "ImageGenerations": { "type": "object", - "description": "The result of the operation if the operation succeeded.", + "description": "The result of a successful image generation operation.", "properties": { "created": { "type": "integer", "format": "unixtime", - "description": "A timestamp when this job or item was created (in unix epochs)." + "description": "A timestamp representing when this operation was started.\nExpressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000." }, "data": { - "description": "The images generated by the operator." + "type": "array", + "description": "The images generated by the operation.", + "items": { + "$ref": "#/definitions/ImageGenerationData" + }, + "x-ms-identifiers": [] } }, "required": [ @@ -1379,53 +1728,174 @@ }, "ImageSize": { "type": "string", - "description": "The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.", + "description": "The desired size of generated images.", "enum": [ "256x256", - "512x512", - "1024x1024" + "512x512" ], "x-ms-enum": { "name": "ImageSize", "modelAsString": true, "values": [ { - "name": "Size256x256", + "name": "size256x256", "value": "256x256", - "description": "Image size of 256x256." + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." }, { - "name": "Size512x512", + "name": "size512x512", "value": "512x512", - "description": "Image size of 512x512." + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + } + ] + } + }, + "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": "APIKey" + }, + "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": [ + "APIKey", + "ConnectionString", + "KeyAndKeyId", + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "x-ms-enum": { + "name": "OnYourDataAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "APIKey", + "description": "Authentication via API key." + }, + { + "name": "connectionString", + "value": "ConnectionString", + "description": "Authentication via connection string." + }, + { + "name": "keyAndKeyId", + "value": "KeyAndKeyId", + "description": "Authentication via key and key ID pair." }, { - "name": "Size1024x1024", - "value": "1024x1024", - "description": "Image size of 1024x1024." + "name": "systemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "Authentication via system-assigned managed identity." + }, + { + "name": "userAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "Authentication via user-assigned managed identity." } ] } }, - "PromptFilterResult": { + "OnYourDataConnectionStringAuthenticationOptions": { "type": "object", - "description": "Content filtering results for a single prompt in the request.", + "description": "The authentication options for Azure OpenAI On Your Data when using a connection string.", "properties": { - "prompt_index": { - "type": "integer", - "format": "int32", - "description": "The index of this prompt in the set of prompt results", - "x-ms-client-name": "promptIndex" + "connectionString": { + "type": "string", + "description": "The connection string to use for authentication." + } + }, + "required": [ + "connectionString" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "ConnectionString" + }, + "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." }, - "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", - "description": "Content filtering results for this prompt", - "x-ms-client-name": "contentFilterResults" + "keyId": { + "type": "string", + "description": "The key ID to use for authentication." } }, "required": [ - "prompt_index" - ] + "key", + "keyId" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "KeyAndKeyId" + }, + "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": "SystemAssignedManagedIdentity" + }, + "OnYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "properties": { + "managedIdentityResourceId": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication." + } + }, + "required": [ + "managedIdentityResourceId" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "UserAssignedManagedIdentity" } }, "parameters": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json index 60ad0cc7291f..3a090370b6ec 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/generated.json @@ -483,6 +483,9 @@ { "$ref": "#/parameters/AudioTranscriptionOptions.file" }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.filename" + }, { "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" }, @@ -547,6 +550,9 @@ { "$ref": "#/parameters/AudioTranslationOptions.file" }, + { + "$ref": "#/parameters/AudioTranslationOptions.filename" + }, { "$ref": "#/parameters/AudioTranslationOptions.responseFormat" }, @@ -697,6 +703,10 @@ "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.", @@ -881,6 +891,10 @@ "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.", @@ -1045,14 +1059,11 @@ "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." - }, - "parameters": { - "description": " The configuration payload used for the Azure chat extension. The structure payload details are specific to the\n extension being configured.\n Azure chat extensions are only compatible with Azure OpenAI." } }, + "discriminator": "type", "required": [ - "type", - "parameters" + "type" ] }, "AzureChatExtensionType": { @@ -1081,12 +1092,181 @@ "type": "array", "description": " The contextual message payload 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/ChatMessage" + "$ref": "#/definitions/ChatResponseMessage" }, "x-ms-identifiers": [] } } }, + "AzureCognitiveSearchChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Azure Cognitive Search when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/AzureCognitiveSearchChatExtensionParameters", + "description": "The parameters to use when configuring Azure Cognitive Search." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "AzureCognitiveSearch" + }, + "AzureCognitiveSearchChatExtensionParameters": { + "type": "object", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.", + "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." + }, + "topNDocuments": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query." + }, + "inScope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "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 + }, + "roleInformation": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "endpoint": { + "type": "string", + "format": "uri", + "description": "The absolute endpoint path for the Azure Cognitive Search resource to use." + }, + "indexName": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Cognitive Search resource." + }, + "key": { + "type": "string", + "description": "The API key to use when interacting with the Azure Cognitive Search resource." + }, + "fieldsMapping": { + "$ref": "#/definitions/AzureCognitiveSearchIndexFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index." + }, + "queryType": { + "$ref": "#/definitions/AzureCognitiveSearchQueryType", + "description": "The query type to use with Azure Cognitive Search." + }, + "semanticConfiguration": { + "type": "string", + "description": "The additional semantic configuration for the query." + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embeddingEndpoint": { + "type": "string", + "format": "uri", + "description": "When using embeddings for search, specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of format https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings?api-version={api-version}." + }, + "embeddingKey": { + "type": "string", + "description": "When using embeddings, specifies the API key to use with the provided embeddings endpoint." + } + }, + "required": [ + "endpoint", + "indexName" + ] + }, + "AzureCognitiveSearchIndexFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Azure Cognitive Search resource.", + "properties": { + "titleField": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "urlField": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepathField": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "contentFields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "contentFieldsSeparator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vectorFields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + } + }, + "AzureCognitiveSearchQueryType": { + "type": "string", + "description": "The type of Azure Cognitive Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "semantic", + "vector", + "vectorSimpleHybrid", + "vectorSemanticHybrid" + ], + "x-ms-enum": { + "name": "AzureCognitiveSearchQueryType", + "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": "vectorSimpleHybrid", + "description": "Represents a combination of the simple query strategy with vector data." + }, + { + "name": "vectorSemanticHybrid", + "value": "vectorSemanticHybrid", + "description": "Represents a combination of semantic search and vector data querying." + } + ] + } + }, "AzureOpenAIOperationState": { "type": "string", "description": "The state of a job or item.", @@ -1171,7 +1351,7 @@ "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "message": { - "$ref": "#/definitions/ChatMessage", + "$ref": "#/definitions/ChatResponseMessage", "description": "The chat message for a given chat completions prompt." }, "index": { @@ -1186,11 +1366,11 @@ "x-ms-client-name": "finishReason" }, "delta": { - "$ref": "#/definitions/ChatMessage", + "$ref": "#/definitions/ChatResponseMessage", "description": "The delta message content for a streaming response." }, "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", + "$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" } @@ -1225,7 +1405,7 @@ "type": "array", "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", "items": { - "$ref": "#/definitions/PromptFilterResult" + "$ref": "#/definitions/ContentFilterResultsForPrompt" }, "x-ms-client-name": "promptFilterResults", "x-ms-identifiers": [] @@ -1250,7 +1430,7 @@ "type": "array", "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", "items": { - "$ref": "#/definitions/ChatMessage" + "$ref": "#/definitions/ChatRequestMessage" }, "x-ms-identifiers": [] }, @@ -1341,31 +1521,140 @@ "messages" ] }, - "ChatMessage": { + "ChatRequestAssistantMessage": { "type": "object", - "description": "A single, role-attributed message within a chat completion interaction.", + "description": "A request chat message representing response or action from the assistant.", "properties": { - "role": { - "$ref": "#/definitions/ChatRole", - "description": "The role associated with this message payload." + "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 text associated with this message payload.", + "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": "The name of the author of this message. `name` is required if role is `function`, and it should be the name of the\nfunction whose response is in the `content`. May contain a-z, A-Z, 0-9, and underscores, with a maximum length of\n64 characters." + "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 name and arguments of a function that should be called, as generated by the model.", + "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": " Additional context data associated with a chat message when requesting chat completions using compatible Azure\n OpenAI chat extensions. This includes information like the intermediate data source retrievals used to service a\n request.\n This context information is only populated when using Azure OpenAI with chat extensions capabilities configured." + "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": [ @@ -1429,7 +1718,7 @@ "description": "The ordered index associated with this completions choice." }, "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", + "$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" }, @@ -1474,7 +1763,7 @@ "type": "array", "description": "Content filtering results for zero or more prompts in the request. In a streaming request,\nresults for different prompts may arrive at different times or in different orders.", "items": { - "$ref": "#/definitions/PromptFilterResult" + "$ref": "#/definitions/ContentFilterResultsForPrompt" }, "x-ms-client-name": "promptFilterResults", "x-ms-identifiers": [] @@ -1727,9 +2016,36 @@ "filtered" ] }, - "ContentFilterResults": { + "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 the content filtering category, if it has been detected.", + "description": "Information about content filtering evaluated against generated model output.", "properties": { "sexual": { "$ref": "#/definitions/ContentFilterResult", @@ -1754,6 +2070,27 @@ } } }, + "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.", @@ -1912,17 +2249,37 @@ "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 functions accepts, described as a JSON Schema object." + "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." @@ -1930,17 +2287,18 @@ "n": { "type": "integer", "format": "int32", - "description": "The number of images to generate (defaults to 1).", + "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": { "$ref": "#/definitions/ImageSize", - "description": "The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 (defaults to 1024x1024).", + "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" }, "response_format": { "$ref": "#/definitions/ImageGenerationResponseFormat", - "description": " The format in which image generation response items should be presented.\n Azure OpenAI only supports URL response items.", + "description": "The format in which image generation response items should be presented.", + "default": "url", "x-ms-client-name": "responseFormat" }, "user": { @@ -1964,12 +2322,12 @@ "modelAsString": true, "values": [ { - "name": "Url", + "name": "url", "value": "url", "description": "Image generation response items should provide a URL from which the image may be retrieved." }, { - "name": "Base64", + "name": "base64", "value": "b64_json", "description": "Image generation response items should provide image data as a base64-encoded string." } @@ -1978,15 +2336,20 @@ }, "ImageGenerations": { "type": "object", - "description": "The result of the operation if the operation succeeded.", + "description": "The result of a successful image generation operation.", "properties": { "created": { "type": "integer", "format": "unixtime", - "description": "A timestamp when this job or item was created (in unix epochs)." + "description": "A timestamp representing when this operation was started.\nExpressed in seconds since the Unix epoch of 1970-01-01T00:00:00+0000." }, "data": { - "description": "The images generated by the operator." + "type": "array", + "description": "The images generated by the operation.", + "items": { + "$ref": "#/definitions/ImageGenerationData" + }, + "x-ms-identifiers": [] } }, "required": [ @@ -1996,53 +2359,174 @@ }, "ImageSize": { "type": "string", - "description": "The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.", + "description": "The desired size of generated images.", "enum": [ "256x256", - "512x512", - "1024x1024" + "512x512" ], "x-ms-enum": { "name": "ImageSize", "modelAsString": true, "values": [ { - "name": "Size256x256", + "name": "size256x256", "value": "256x256", - "description": "Image size of 256x256." + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." }, { - "name": "Size512x512", + "name": "size512x512", "value": "512x512", - "description": "Image size of 512x512." + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + } + ] + } + }, + "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": "APIKey" + }, + "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": [ + "APIKey", + "ConnectionString", + "KeyAndKeyId", + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "x-ms-enum": { + "name": "OnYourDataAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "APIKey", + "description": "Authentication via API key." + }, + { + "name": "connectionString", + "value": "ConnectionString", + "description": "Authentication via connection string." }, { - "name": "Size1024x1024", - "value": "1024x1024", - "description": "Image size of 1024x1024." + "name": "keyAndKeyId", + "value": "KeyAndKeyId", + "description": "Authentication via key and key ID pair." + }, + { + "name": "systemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "Authentication via system-assigned managed identity." + }, + { + "name": "userAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "Authentication via user-assigned managed identity." } ] } }, - "PromptFilterResult": { + "OnYourDataConnectionStringAuthenticationOptions": { "type": "object", - "description": "Content filtering results for a single prompt in the request.", + "description": "The authentication options for Azure OpenAI On Your Data when using a connection string.", "properties": { - "prompt_index": { - "type": "integer", - "format": "int32", - "description": "The index of this prompt in the set of prompt results", - "x-ms-client-name": "promptIndex" + "connectionString": { + "type": "string", + "description": "The connection string to use for authentication." + } + }, + "required": [ + "connectionString" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "ConnectionString" + }, + "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." }, - "content_filter_results": { - "$ref": "#/definitions/ContentFilterResults", - "description": "Content filtering results for this prompt", - "x-ms-client-name": "contentFilterResults" + "keyId": { + "type": "string", + "description": "The key ID to use for authentication." } }, "required": [ - "prompt_index" - ] + "key", + "keyId" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "KeyAndKeyId" + }, + "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": "SystemAssignedManagedIdentity" + }, + "OnYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "properties": { + "managedIdentityResourceId": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication." + } + }, + "required": [ + "managedIdentityResourceId" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "UserAssignedManagedIdentity" } }, "parameters": { @@ -2054,6 +2538,14 @@ "type": "file", "x-ms-parameter-location": "method" }, + "AudioTranscriptionOptions.filename": { + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, "AudioTranscriptionOptions.language": { "name": "language", "in": "formData", @@ -2142,6 +2634,14 @@ "type": "file", "x-ms-parameter-location": "method" }, + "AudioTranslationOptions.filename": { + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, "AudioTranslationOptions.model": { "name": "model", "in": "formData", diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/get_image_operation_status.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/get_image_operation_status.json new file mode 100644 index 000000000000..8e42b89bf30a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/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": "2023-12-01-preview", + "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/preview/2023-12-01-preview/examples/start_generate_image.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/examples/start_generate_image.json new file mode 100644 index 000000000000..1da29ebdfe21 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/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": "2023-12-01-preview", + "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/preview/2023-12-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json new file mode 100644 index 000000000000..a1e57276ceda --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/generated.json @@ -0,0 +1,3672 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API", + "version": "2023-12-01-preview", + "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/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.", + "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": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AudioTranscriptionOptions" + } + } + ], + "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/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.", + "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": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AudioTranslationOptions" + } + } + ], + "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/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" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + } + } + ], + "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/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" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CompletionsOptions" + } + } + ], + "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/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" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EmbeddingsOptions" + } + } + ], + "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/embeddings.json" + } + } + } + }, + "/deployments/{deploymentId}/extensions/chat/completions": { + "post": { + "operationId": "GetChatCompletionsWithAzureExtensions", + "description": "Gets chat completions for the provided chat messages.\nThis is an Azure-specific version of chat completions that supports integration with configured data sources and\nother augmentations to the base chat completions capabilities.", + "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": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ChatCompletionsOptions" + } + } + ], + "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/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/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/extensions_chat_completions_azure_search_advanced.json" + }, + "Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/extensions_chat_completions_aml_index.json" + }, + "Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/extensions_chat_completions_cosmos_db.json" + }, + "Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/extensions_chat_completions_elasticsearch.json" + }, + "Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.": { + "$ref": "./examples/extensions_chat_completions_pinecone.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" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageGenerationOptions" + } + } + ], + "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/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" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.file" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.filename" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.responseFormat" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.language" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.prompt" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.temperature" + }, + { + "$ref": "#/parameters/AudioTranscriptionOptions.model" + } + ], + "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/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" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.file" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.filename" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.responseFormat" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.prompt" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.temperature" + }, + { + "$ref": "#/parameters/AudioTranslationOptions.model" + } + ], + "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/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" + } + } + }, + "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." + }, + "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" + ] + }, + "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" + ] + }, + "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": [ + "AzureCognitiveSearch", + "AzureMLIndex", + "AzureCosmosDB", + "Elasticsearch", + "Pinecone" + ], + "x-ms-enum": { + "name": "AzureChatExtensionType", + "modelAsString": true, + "values": [ + { + "name": "azureCognitiveSearch", + "value": "AzureCognitiveSearch", + "description": "Represents the use of Azure Cognitive Search as an Azure OpenAI chat extension." + }, + { + "name": "azureMachineLearningIndex", + "value": "AzureMLIndex", + "description": "Represents the use of Azure Machine Learning index as an Azure OpenAI chat extension." + }, + { + "name": "azureCosmosDB", + "value": "AzureCosmosDB", + "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": { + "messages": { + "type": "array", + "description": " The contextual message payload 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/ChatResponseMessage" + }, + "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" + ] + }, + "AzureCognitiveSearchChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Azure Cognitive Search when using it as an Azure OpenAI chat\nextension.", + "properties": { + "parameters": { + "$ref": "#/definitions/AzureCognitiveSearchChatExtensionParameters", + "description": "The parameters to use when configuring Azure Cognitive Search." + } + }, + "required": [ + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AzureChatExtensionConfiguration" + } + ], + "x-ms-discriminator-value": "AzureCognitiveSearch" + }, + "AzureCognitiveSearchChatExtensionParameters": { + "type": "object", + "description": "Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.", + "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." + }, + "topNDocuments": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query." + }, + "inScope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "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 + }, + "roleInformation": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "endpoint": { + "type": "string", + "format": "uri", + "description": "The absolute endpoint path for the Azure Cognitive Search resource to use." + }, + "indexName": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Cognitive Search resource." + }, + "fieldsMapping": { + "$ref": "#/definitions/AzureCognitiveSearchIndexFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index." + }, + "queryType": { + "$ref": "#/definitions/AzureCognitiveSearchQueryType", + "description": "The query type to use with Azure Cognitive Search." + }, + "semanticConfiguration": { + "type": "string", + "description": "The additional semantic configuration for the query." + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embeddingDependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search." + } + }, + "required": [ + "endpoint", + "indexName" + ] + }, + "AzureCognitiveSearchIndexFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Azure Cognitive Search resource.", + "properties": { + "titleField": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "urlField": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepathField": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "contentFields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "contentFieldsSeparator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vectorFields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + }, + "imageVectorFields": { + "type": "array", + "description": "The names of fields that represent image vector data.", + "items": { + "type": "string" + } + } + } + }, + "AzureCognitiveSearchQueryType": { + "type": "string", + "description": "The type of Azure Cognitive Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "semantic", + "vector", + "vectorSimpleHybrid", + "vectorSemanticHybrid" + ], + "x-ms-enum": { + "name": "AzureCognitiveSearchQueryType", + "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": "vectorSimpleHybrid", + "description": "Represents a combination of the simple query strategy with vector data." + }, + { + "name": "vectorSemanticHybrid", + "value": "vectorSemanticHybrid", + "description": "Represents a combination of semantic search and vector data querying." + } + ] + } + }, + "AzureCosmosDBChatExtensionConfiguration": { + "type": "object", + "description": "A specific representation of configurable options for Elasticsearch 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": "AzureCosmosDB" + }, + "AzureCosmosDBChatExtensionParameters": { + "type": "object", + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore.", + "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." + }, + "topNDocuments": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query." + }, + "inScope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "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 + }, + "roleInformation": { + "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." + }, + "databaseName": { + "type": "string", + "description": "The MongoDB vCore database name to use with Azure Cosmos DB." + }, + "containerName": { + "type": "string", + "description": "The name of the Azure Cosmos DB resource container." + }, + "indexName": { + "type": "string", + "description": "The MongoDB vCore index name to use with Azure Cosmos DB." + }, + "fieldsMapping": { + "$ref": "#/definitions/AzureCosmosDBFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index." + }, + "embeddingDependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search." + } + }, + "required": [ + "databaseName", + "containerName", + "indexName", + "fieldsMapping" + ] + }, + "AzureCosmosDBFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.", + "properties": { + "vectorFields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "required": [ + "vectorFields" + ] + }, + "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": "AzureMLIndex" + }, + "AzureMachineLearningIndexChatExtensionParameters": { + "type": "object", + "description": "Parameters for the Azure Machine Learning vector index chat extension.", + "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." + }, + "topNDocuments": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query." + }, + "inScope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "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 + }, + "roleInformation": { + "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." + }, + "projectResourceId": { + "type": "string", + "description": "The resource ID of the Azure Machine Learning project." + }, + "name": { + "type": "string", + "description": "The Azure Machine Learning vector index name." + }, + "version": { + "type": "string", + "description": "The version of the Azure Machine Learning vector index." + }, + "filter": { + "type": "string", + "description": "Search filter. Only supported if the Azure Machine Learning vector index is of type AzureSearch." + } + }, + "required": [ + "projectResourceId", + "name", + "version" + ] + }, + "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" + }, + "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": [ + "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": [] + }, + "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", + "system_fingerprint", + "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" + }, + "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": [] + }, + "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." + }, + "dataSources": { + "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-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.\"" + }, + "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": "string", + "description": "The valid response formats Chat Completions can provide. Used to enable JSON mode.", + "enum": [ + "text", + "json_object" + ], + "x-ms-enum": { + "name": "ChatCompletionsResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "text", + "value": "text", + "description": "Use the default, plain text response format." + }, + { + "name": "jsonObject", + "value": "json_object", + "description": "Use a response format that guarantees emission of a valid JSON object. Only structure is guaranteed and contents must\nstill be validated." + } + ] + } + }, + "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" + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "assistant" + }, + "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." + } + ] + } + }, + "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." + }, + "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": { + "id": { + "type": "string", + "description": "The ID of the custom blocklist evaluated." + }, + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + } + }, + "required": [ + "id", + "filtered" + ] + }, + "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" + ] + }, + "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": { + "severity": { + "$ref": "#/definitions/ContentFilterSeverity", + "description": "Ratings for the intensity and risk level of filtered content." + }, + "filtered": { + "type": "boolean", + "description": "A value indicating whether or not the content has been filtered." + } + }, + "required": [ + "severity", + "filtered" + ] + }, + "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": { + "type": "array", + "description": "Describes detection results against configured custom blocklists.", + "items": { + "$ref": "#/definitions/ContentFilterBlocklistIdResult" + }, + "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." + } + } + }, + "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": { + "type": "array", + "description": "Describes detection results against configured custom blocklists.", + "items": { + "$ref": "#/definitions/ContentFilterBlocklistIdResult" + }, + "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.", + "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." + }, + "topNDocuments": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query." + }, + "inScope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "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 + }, + "roleInformation": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "endpoint": { + "type": "string", + "format": "uri", + "description": "The endpoint of Elasticsearch®." + }, + "indexName": { + "type": "string", + "description": "The index name of Elasticsearch®." + }, + "fieldsMapping": { + "$ref": "#/definitions/ElasticsearchIndexFieldMappingOptions", + "description": "The index field mapping options of Elasticsearch®." + }, + "queryType": { + "$ref": "#/definitions/ElasticsearchQueryType", + "description": "The query type of Elasticsearch®." + }, + "embeddingDependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search." + } + }, + "required": [ + "endpoint", + "indexName" + ] + }, + "ElasticsearchIndexFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Elasticsearch® resource.", + "properties": { + "titleField": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "urlField": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepathField": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "contentFields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "contentFieldsSeparator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vectorFields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + } + }, + "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" + } + } + }, + "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" + }, + "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" + } + } + }, + "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": { + "$ref": "#/definitions/ImageSize", + "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" + }, + "response_format": { + "$ref": "#/definitions/ImageGenerationResponseFormat", + "description": "The format in which image generation response items should be presented.", + "default": "url", + "x-ms-client-name": "responseFormat" + }, + "quality": { + "$ref": "#/definitions/ImageGenerationQuality", + "description": "The desired image generation quality level to use.\nOnly configurable with dall-e-3 models.", + "default": "standard" + }, + "style": { + "$ref": "#/definitions/ImageGenerationStyle", + "description": "The desired image generation style to use.\nOnly configurable with dall-e-3 models.", + "default": "vivid" + }, + "user": { + "type": "string", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse." + } + }, + "required": [ + "prompt" + ] + }, + "ImageGenerationQuality": { + "type": "string", + "description": "An image generation configuration that specifies how the model should prioritize quality, cost, and speed.\nOnly configurable with dall-e-3 models.", + "enum": [ + "standard", + "hd" + ], + "x-ms-enum": { + "name": "ImageGenerationQuality", + "modelAsString": true, + "values": [ + { + "name": "standard", + "value": "standard", + "description": "Requests image generation with standard, balanced characteristics of quality, cost, and speed." + }, + { + "name": "hd", + "value": "hd", + "description": "Requests image generation with higher quality, higher cost and lower speed relative to standard." + } + ] + } + }, + "ImageGenerationResponseFormat": { + "type": "string", + "description": "The format in which the generated images are returned.", + "enum": [ + "url", + "b64_json" + ], + "x-ms-enum": { + "name": "ImageGenerationResponseFormat", + "modelAsString": true, + "values": [ + { + "name": "url", + "value": "url", + "description": "Image generation response items should provide a URL from which the image may be retrieved." + }, + { + "name": "base64", + "value": "b64_json", + "description": "Image generation response items should provide image data as a base64-encoded string." + } + ] + } + }, + "ImageGenerationStyle": { + "type": "string", + "description": "An image generation configuration that specifies how the model should incorporate realism and other visual characteristics.\nOnly configurable with dall-e-3 models.", + "enum": [ + "natural", + "vivid" + ], + "x-ms-enum": { + "name": "ImageGenerationStyle", + "modelAsString": true, + "values": [ + { + "name": "natural", + "value": "natural", + "description": "Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics." + }, + { + "name": "vivid", + "value": "vivid", + "description": "Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic\ncharacteristics." + } + ] + } + }, + "ImageGenerations": { + "type": "object", + "description": "The result of a successful image generation operation.", + "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" + ] + }, + "ImageSize": { + "type": "string", + "description": "The desired size of generated images.", + "enum": [ + "256x256", + "512x512", + "1024x1024", + "1792x1024", + "1024x1792" + ], + "x-ms-enum": { + "name": "ImageSize", + "modelAsString": true, + "values": [ + { + "name": "size256x256", + "value": "256x256", + "description": "Very small image size of 256x256 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size512x512", + "value": "512x512", + "description": "A smaller image size of 512x512 pixels.\nOnly supported with dall-e-2 models." + }, + { + "name": "size1024x1024", + "value": "1024x1024", + "description": "A standard, square image size of 1024x1024 pixels.\nSupported by both dall-e-2 and dall-e-3 models." + }, + { + "name": "size1792x1024", + "value": "1792x1024", + "description": "A wider image size of 1024x1792 pixels.\nOnly supported with dall-e-3 models." + }, + { + "name": "size1024x1792", + "value": "1024x1792", + "description": "A taller image size of 1792x1024 pixels.\nOnly supported with dall-e-3 models." + } + ] + } + }, + "MaxTokensFinishDetails": { + "type": "object", + "description": "A structured representation of a stop reason that signifies a token limit was reached before the model could naturally\ncomplete.", + "allOf": [ + { + "$ref": "#/definitions/ChatFinishDetails" + } + ], + "x-ms-discriminator-value": "max_tokens" + }, + "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": "APIKey" + }, + "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": [ + "APIKey", + "ConnectionString", + "KeyAndKeyId", + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "x-ms-enum": { + "name": "OnYourDataAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "APIKey", + "description": "Authentication via API key." + }, + { + "name": "connectionString", + "value": "ConnectionString", + "description": "Authentication via connection string." + }, + { + "name": "keyAndKeyId", + "value": "KeyAndKeyId", + "description": "Authentication via key and key ID pair." + }, + { + "name": "systemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "Authentication via system-assigned managed identity." + }, + { + "name": "userAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "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": { + "connectionString": { + "type": "string", + "description": "The connection string to use for authentication." + } + }, + "required": [ + "connectionString" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "ConnectionString" + }, + "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": { + "deploymentName": { + "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." + } + }, + "required": [ + "deploymentName" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "DeploymentName" + }, + "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/OnYourDataAuthenticationOptions", + "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." + }, + "keyId": { + "type": "string", + "description": "The key ID to use for authentication." + } + }, + "required": [ + "key", + "keyId" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "KeyAndKeyId" + }, + "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": { + "modelId": { + "type": "string", + "description": "The embedding model ID build inside the search service. Currently only supported by Elasticsearch®." + } + }, + "required": [ + "modelId" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "ModelId" + }, + "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": "SystemAssignedManagedIdentity" + }, + "OnYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "type": "object", + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "properties": { + "managedIdentityResourceId": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication." + } + }, + "required": [ + "managedIdentityResourceId" + ], + "allOf": [ + { + "$ref": "#/definitions/OnYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "UserAssignedManagedIdentity" + }, + "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", + "DeploymentName", + "ModelId" + ], + "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": "DeploymentName", + "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": "ModelId", + "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 Elasticsearch 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.", + "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." + }, + "topNDocuments": { + "type": "integer", + "format": "int32", + "description": "The configured top number of documents to feature for the configured query." + }, + "inScope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "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 + }, + "roleInformation": { + "type": "string", + "description": "Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant's personality and tell it how to format responses. There's a 100 token limit for it, and it counts against the overall token limit." + }, + "environment": { + "type": "string", + "description": "The environment name of Pinecone." + }, + "indexName": { + "type": "string", + "description": "The name of the Pinecone database index." + }, + "fieldsMapping": { + "$ref": "#/definitions/PineconeFieldMappingOptions", + "description": "Customized field mapping behavior to use when interacting with the search index." + }, + "embeddingDependency": { + "$ref": "#/definitions/OnYourDataVectorizationSource", + "description": "The embedding dependency for vector search." + } + }, + "required": [ + "environment", + "indexName", + "fieldsMapping" + ] + }, + "PineconeFieldMappingOptions": { + "type": "object", + "description": "Optional settings to control how fields are processed when using a configured Pinecone resource.", + "properties": { + "titleField": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "urlField": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepathField": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "contentFields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "contentFieldsSeparator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vectorFields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + }, + "imageVectorFields": { + "type": "array", + "description": "The names of fields that represent image vector data.", + "items": { + "type": "string" + } + } + } + }, + "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": { + "AudioTranscriptionOptions.file": { + "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", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.filename": { + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.language": { + "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", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.model": { + "name": "model", + "in": "formData", + "description": "The model to use for this transcription request.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.prompt": { + "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", + "x-ms-parameter-location": "method" + }, + "AudioTranscriptionOptions.responseFormat": { + "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-parameter-location": "method", + "x-ms-client-name": "responseFormat" + }, + "AudioTranscriptionOptions.temperature": { + "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", + "x-ms-parameter-location": "method" + }, + "AudioTranslationOptions.file": { + "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", + "x-ms-parameter-location": "method" + }, + "AudioTranslationOptions.filename": { + "name": "filename", + "in": "formData", + "description": "The optional filename or descriptive identifier to associate with with the audio data.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranslationOptions.model": { + "name": "model", + "in": "formData", + "description": "The model to use for this translation request.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AudioTranslationOptions.prompt": { + "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", + "x-ms-parameter-location": "method" + }, + "AudioTranslationOptions.responseFormat": { + "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-parameter-location": "method", + "x-ms-client-name": "responseFormat" + }, + "AudioTranslationOptions.temperature": { + "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", + "x-ms-parameter-location": "method" + }, + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.json index 951d6026e9a4..8cc3546fb0db 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.json @@ -1024,7 +1024,7 @@ { "properties": { "detected": { - "type": "string" + "type": "boolean" } } } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.yaml index e75605cf4982..065fc0946c97 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.yaml +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-12-01-preview/inference.yaml @@ -647,7 +647,7 @@ components: - $ref: '#/components/schemas/contentFilterResultBase' - properties: detected: - type: string + type: boolean required: - detected - filtered 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 1a96674b2566..3369820977c1 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 @@ -280,7 +280,7 @@ "description": "The representation of a single prompt completion as part of an overall chat completions request.\nGenerally, `n` choices are generated per provided prompt with a default value of 1.\nToken limits and other settings may limit the number of choices generated.", "properties": { "message": { - "$ref": "#/definitions/ChatMessage", + "$ref": "#/definitions/ChatResponseMessage", "description": "The chat message for a given chat completions prompt." }, "index": { @@ -295,7 +295,7 @@ "x-ms-client-name": "finishReason" }, "delta": { - "$ref": "#/definitions/ChatMessage", + "$ref": "#/definitions/ChatResponseMessage", "description": "The delta message content for a streaming response." } }, @@ -345,7 +345,7 @@ "type": "array", "description": "The collection of context messages associated with this chat completions request.\nTypical usage begins with a chat message for the System role that provides instructions for\nthe behavior of the assistant, followed by alternating messages between the User and\nAssistant roles.", "items": { - "$ref": "#/definitions/ChatMessage" + "$ref": "#/definitions/ChatRequestMessage" }, "x-ms-identifiers": [] }, @@ -416,17 +416,100 @@ "messages" ] }, - "ChatMessage": { + "ChatRequestAssistantMessage": { "type": "object", - "description": "A single, role-attributed message within a chat completion interaction.", + "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." + } + }, + "required": [ + "content" + ], + "allOf": [ + { + "$ref": "#/definitions/ChatRequestMessage" + } + ], + "x-ms-discriminator-value": "assistant" + }, + "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 role associated with this message payload." + "description": "The chat role associated with the message." }, "content": { "type": "string", - "description": "The text associated with this message payload.", + "description": "The content of the message.", "x-nullable": true } }, diff --git a/specification/communication/Communication.JobRouter/main.tsp b/specification/communication/Communication.JobRouter/main.tsp index 9d8b509388d1..73e2be566bf7 100644 --- a/specification/communication/Communication.JobRouter/main.tsp +++ b/specification/communication/Communication.JobRouter/main.tsp @@ -10,7 +10,6 @@ using TypeSpec.Rest; using TypeSpec.Http; using TypeSpec.Versioning; -@useAuth(ApiKeyAuth) @service({ title: "Azure Communication Routing Service", }) diff --git a/specification/communication/Communication.JobRouter/tspconfig.yaml b/specification/communication/Communication.JobRouter/tspconfig.yaml index a31a88281844..bcce2df033a3 100644 --- a/specification/communication/Communication.JobRouter/tspconfig.yaml +++ b/specification/communication/Communication.JobRouter/tspconfig.yaml @@ -49,6 +49,7 @@ options: service-name: JobRouter custom-types-subpackage: "implementation.models" custom-types: "BestWorkerModeInternal,CancelExceptionActionInternal,ClassificationPolicyInternal,ConditionalQueueSelectorAttachmentInternal,ConditionalWorkerSelectorAttachmentInternal,DirectMapRouterRuleInternal,DistributionModeInternal,DistributionPolicyInternal,ExceptionActionInternal,ExceptionPolicyInternal,ExceptionRuleInternal,ExceptionTriggerInternal,ExpressionRouterRuleInternal,FunctionRouterRuleInternal,LongestIdleModeInternal,ManualReclassifyExceptionActionInternal,PassThroughQueueSelectorAttachmentInternal,PassThroughWorkerSelectorAttachmentInternal,QueueLengthExceptionTriggerInternal,QueueSelectorAttachmentInternal,QueueWeightedAllocationInternal,ReclassifyExceptionActionInternal,RoundRobinModeInternal,RouterJobInternal,RouterQueueInternal,RouterQueueSelectorInternal,RouterQueueStatisticsInternal,RouterRuleInternal,RouterWorkerInternal,RouterWorkerSelectorInternal,RuleEngineQueueSelectorAttachmentInternal,RuleEngineWorkerSelectorAttachmentInternal,StaticQueueSelectorAttachmentInternal,StaticRouterRuleInternal,StaticWorkerSelectorAttachmentInternal,WaitTimeExceptionTriggerInternal,WebhookRouterRuleInternal,WeightedAllocationQueueSelectorAttachmentInternal,WeightedAllocationWorkerSelectorAttachmentInternal,WorkerSelectorAttachmentInternal,WorkerWeightedAllocationInternal,CancelJobOptionsInternal,CancelJobResultInternal,CloseJobOptionsInternal,CloseJobResultInternal,CompleteJobOptionsInternal,CompleteJobResultInternal,DeclineJobOfferOptionsInternal,DeclineJobOfferResultInternal,ReclassifyJobOptionsInternal,ReclassifyJobResultInternal,JobMatchingModeInternal,SuspendModeInternal,QueueAndMatchModeInternal,ScheduleAndSuspendModeInternal" + customization-class: customization/src/main/java/JobRouterSdkCustomization.java "@azure-tools/typespec-ts": emitter-output-dir: "{js-sdk-folder}/sdk/{service-directory-name}/communication-job-router-rest" package-dir: "communication-job-router-rest" diff --git a/specification/communication/data-plane/CallAutomation/readme.md b/specification/communication/data-plane/CallAutomation/readme.md index b8b9d759db6b..a185e86fa24e 100644 --- a/specification/communication/data-plane/CallAutomation/readme.md +++ b/specification/communication/data-plane/CallAutomation/readme.md @@ -26,7 +26,7 @@ These are the global settings for the communicationservices. ```yaml openapi-type: data-plane -tag: package-2023-03-06 +tag: package-2023-10-15 ``` ### Tag: package-2022-04-07-preview @@ -61,6 +61,17 @@ title: Azure Communication Services ``` +### Tag: package-2023-10-15 + +These settings apply only when `--tag=package-2023-10-15` is specified on the command line. + +```yaml $(tag) == 'package-2023-10-15' +input-file: + - stable/2023-10-15/communicationservicescallautomation.json +title: + Azure Communication Services +``` + --- # Code Generation diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/communicationservicescallautomation.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/communicationservicescallautomation.json new file mode 100644 index 000000000000..2cb552cb1658 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/communicationservicescallautomation.json @@ -0,0 +1,3004 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-10-15", + "title": "Azure Communication Service Call Automation APIs", + "description": "Azure Communication Service Call Automation APIs" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/calling/callConnections": { + "post": { + "tags": [ + "PreConnections" + ], + "summary": "Create an outbound call.", + "description": "Create an outbound call.", + "operationId": "CreateCall", + "parameters": [ + { + "name": "createCallRequest", + "in": "body", + "description": "The create call request.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateCallRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "201": { + "description": "Returns details of the call properties once the CreateCall request is received by service. You will receive CallConnected event at your specified callback URI, once the call is connected.", + "schema": { + "$ref": "#/definitions/CallConnectionProperties" + } + } + }, + "x-ms-examples": { + "CreateCall": { + "$ref": "./examples/CreateCall.json" + } + } + } + }, + "/calling/callConnections:answer": { + "post": { + "tags": [ + "PreConnections" + ], + "summary": "Answer a Call.", + "description": "Answer a call using the IncomingCallContext from Event Grid.", + "operationId": "AnswerCall", + "parameters": [ + { + "name": "answerCallRequest", + "in": "body", + "description": "The answer call request.", + "required": true, + "schema": { + "$ref": "#/definitions/AnswerCallRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "200": { + "description": "Returns details of the call properties once the AnswerCall request is received by service. You will receive CallConnected event at your specified callback URI, once the call is connected.", + "schema": { + "$ref": "#/definitions/CallConnectionProperties" + } + } + }, + "x-ms-examples": { + "AnswerCall": { + "$ref": "./examples/AnswerCall.json" + } + } + } + }, + "/calling/callConnections:redirect": { + "post": { + "tags": [ + "PreConnections" + ], + "summary": "Redirect a call.", + "description": "Redirect a call.", + "operationId": "RedirectCall", + "parameters": [ + { + "name": "redirectCallRequest", + "in": "body", + "description": "The redirect call request.", + "required": true, + "schema": { + "$ref": "#/definitions/RedirectCallRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "204": { + "description": "The service has redirected the call to specified endpoint." + } + }, + "x-ms-examples": { + "RedirectCall": { + "$ref": "./examples/RedirectCall.json" + } + } + } + }, + "/calling/callConnections:reject": { + "post": { + "tags": [ + "PreConnections" + ], + "summary": "Reject the call.", + "description": "Reject the call.", + "operationId": "RejectCall", + "parameters": [ + { + "name": "rejectCallRequest", + "in": "body", + "description": "The reject call request.", + "required": true, + "schema": { + "$ref": "#/definitions/RejectCallRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "204": { + "description": "The service has rejected the call." + } + }, + "x-ms-examples": { + "RejectCall": { + "$ref": "./examples/RejectCall.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}": { + "get": { + "tags": [ + "MidConnections" + ], + "summary": "Get the detail properties of an ongoing call.", + "operationId": "CallConnection_GetCall", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "200": { + "description": "Returns details of the call properties.", + "schema": { + "$ref": "#/definitions/CallConnectionProperties" + } + } + }, + "x-ms-examples": { + "CallConnection_GetCall": { + "$ref": "./examples/CallConnection_GetCall.json" + } + } + }, + "delete": { + "tags": [ + "MidConnections" + ], + "summary": "Hang up call automation service from the call. This will make call automation service leave the call, but does not terminate if there are more than 1 caller in the call.", + "description": "Hang up call automation service from the call. This will make call automation service leave the call, but does not terminate if there are more than 1 caller in the call.", + "operationId": "CallConnection_HangupCall", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "204": { + "description": "Call automation service has left the call." + } + }, + "x-ms-examples": { + "CallConnection_HangupCall": { + "$ref": "./examples/CallConnection_HangupCall.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:terminate": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Terminate a call using CallConnectionId.", + "description": "Terminate a call using CallConnectionId.", + "operationId": "CallConnection_TerminateCall", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The terminate call request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "204": { + "description": "The call is terminated." + } + }, + "x-ms-examples": { + "CallConnection_TerminateCall": { + "$ref": "./examples/CallConnection_TerminateCall.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:transferToParticipant": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Transfer the call to a participant.", + "description": "Transfer the call to a participant.", + "operationId": "CallConnection_TransferToParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "transferToParticipantRequest", + "in": "body", + "description": "The transfer to participant request.", + "required": true, + "schema": { + "$ref": "#/definitions/TransferToParticipantRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "202": { + "description": "The service has accepted the transfer request and will begin processing it. You will receive either CallTransferAccepted or CallTransferFailed event at your specified callback URI to update you on the status of the request.", + "schema": { + "$ref": "#/definitions/TransferCallResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_TransferToParticipant": { + "$ref": "./examples/CallConnection_TransferToParticipant.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:play": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Plays audio to participants in the call.", + "description": "Plays audio to participants in the call.", + "operationId": "CallMedia_Play", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "playRequest", + "in": "body", + "description": "play request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/PlayRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "202": { + "description": "The service has accepted the play request and will begin processing it. You will receive either PlayCompleted or PlayFailed event at your specified callback URI to update you on the status of the request." + } + }, + "x-ms-examples": { + "CallMedia_Play": { + "$ref": "./examples/CallMedia_Play.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:cancelAllMediaOperations": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Cancel all media operations in a call.", + "description": "Cancel all media operations in a call.", + "operationId": "CallMedia_CancelAllMediaOperations", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "202": { + "description": "The service has accepted the cancel request and will begin processing it. You will receive the RecognizeCanceled and/or PlayCanceled event at your specified callback URI to update you on the status of the request, based on which media operation has been canceled by it." + } + }, + "x-ms-examples": { + "CallMedia_CancelAllMediaOperations": { + "$ref": "./examples/CallMedia_CancelAllMediaOperations.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:recognize": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Recognize media from call.", + "description": "Recognize media from call.", + "operationId": "CallMedia_Recognize", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "recognizeRequest", + "in": "body", + "description": "The media recognize request", + "required": true, + "schema": { + "$ref": "#/definitions/RecognizeRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "202": { + "description": "The service has accepted the recognize request and will begin processing it. You will receive either RecognizeCompleted or RecognizeFailed event at your specified callback URI to update you on the status of the request." + } + }, + "x-ms-examples": { + "CallMedia_Recognize": { + "$ref": "./examples/CallMedia_Recognize.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:startContinuousDtmfRecognition": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Start continuous Dtmf recognition by subscribing to tones.", + "operationId": "CallMedia_StartContinuousDtmfRecognition", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "continuousDtmfRecognitionRequest", + "in": "body", + "description": "The continuous recognize request", + "required": true, + "schema": { + "$ref": "#/definitions/ContinuousDtmfRecognitionRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "200": { + "description": "The service has started continuous dtmf recognition. You will receive either the ContinuousDtmfRecognitionToneReceived, ContinuousDtmfRecognitionToneFailed or ContinuousDtmfRecognitionStopped event at your specified callback URI. Continuous dtmf recognition can run in parallel with other media operations. For example if the Recognize operation is also active and a dtmf is detected, both ContinuousDtmfRecognitionToneReceived and RecognizeCompleted events will be received." + } + }, + "x-ms-examples": { + "CallMedia_StartContinuousDtmfRecognition": { + "$ref": "./examples/CallMedia_StartContinuousDtmfRecognition.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:stopContinuousDtmfRecognition": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Stop continuous Dtmf recognition by unsubscribing to tones.", + "operationId": "CallMedia_StopContinuousDtmfRecognition", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "continuousDtmfRecognitionRequest", + "in": "body", + "description": "The continuous recognize request", + "required": true, + "schema": { + "$ref": "#/definitions/ContinuousDtmfRecognitionRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "200": { + "description": "The service has stopped continuous dtmf recognition. If continuous dtmf recognition was previously started, you will receive the ContinuousDtmfRecognitionStopped event at your specified callback URI." + } + }, + "x-ms-examples": { + "CallMedia_StopContinuousDtmfRecognition": { + "$ref": "./examples/CallMedia_StopContinuousDtmfRecognition.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:sendDtmfTones": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Send dtmf tones.", + "description": "Send dtmf tones.", + "operationId": "CallMedia_SendDtmfTones", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "sendDtmfTonesRequest", + "in": "body", + "description": "The send dtmf tones request", + "required": true, + "schema": { + "$ref": "#/definitions/SendDtmfTonesRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "202": { + "description": "The service has accepted the send dtmf tones request and will begin processing it. You will receive either the SendDtmfTonesCompleted or the SendDtmfTonesFailed event at your specified callback URI to update you on the status of the request.", + "schema": { + "$ref": "#/definitions/SendDtmfTonesResult" + } + } + }, + "x-ms-examples": { + "CallMedia_SendDtmfTones": { + "$ref": "./examples/CallMedia_SendDtmfTones.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants": { + "get": { + "tags": [ + "MidConnections" + ], + "summary": "Get participants from a call.", + "description": "Get participants from a call.", + "operationId": "CallConnection_GetParticipants", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection Id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "200": { + "description": "Returns the get participants response.", + "schema": { + "$ref": "#/definitions/GetParticipantsResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_GetParticipants": { + "$ref": "./examples/CallConnection_GetParticipants.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/calling/callConnections/{callConnectionId}/participants:add": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Add a participant to the call.", + "description": "Add a participant to the call.", + "operationId": "CallConnection_AddParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection Id", + "required": true, + "type": "string" + }, + { + "name": "addParticipantRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AddParticipantRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "202": { + "description": "The service has accepted the add participant request and will begin processing it. You will receive either AddParticipantSucceeded or AddParticipantFailed event at your specified callback URI to update you on the status of the request.", + "schema": { + "$ref": "#/definitions/AddParticipantResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_AddParticipant": { + "$ref": "./examples/CallConnection_AddParticipant.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants:remove": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Remove a participant from the call using identifier.", + "description": "Remove a participant from the call using identifier.", + "operationId": "CallConnection_RemoveParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "removeParticipantRequest", + "in": "body", + "description": "The participant to be removed from the call.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveParticipantRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "202": { + "description": "The service has accepted the remove participant request and will begin processing it. You will receive either RemoveParticipantSucceeded or RemoveParticipantFailed event at your specified callback URI to update you on the status of the request.", + "schema": { + "$ref": "#/definitions/RemoveParticipantResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_RemoveParticipant": { + "$ref": "./examples/CallConnection_RemoveParticipant.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants:mute": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Mute participants from the call using identifier.", + "description": "Mute participants from the call using identifier.", + "operationId": "CallConnection_Mute", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "muteParticipantsRequest", + "in": "body", + "description": "The participants to be muted from the call.", + "required": true, + "schema": { + "$ref": "#/definitions/MuteParticipantsRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "200": { + "description": "Returns the mute participants response", + "schema": { + "$ref": "#/definitions/MuteParticipantsResult" + } + } + }, + "x-ms-examples": { + "CallConnection_Mute": { + "$ref": "./examples/CallConnection_Mute.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants:cancelAddParticipant": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Cancel add participant operation.", + "description": "Cancel add participant operation.", + "operationId": "CallConnection_CancelAddParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection Id", + "required": true, + "type": "string" + }, + { + "name": "cancelAddParticipantRequest", + "in": "body", + "description": "Cancellation request.", + "required": true, + "schema": { + "$ref": "#/definitions/CancelAddParticipantRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "202": { + "description": "Returns the cancelAddParticipant response", + "schema": { + "$ref": "#/definitions/CancelAddParticipantResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_CancelAddParticipant": { + "$ref": "./examples/CallConnection_CancelAddParticipant.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants/{participantRawId}": { + "get": { + "tags": [ + "MidConnections" + ], + "summary": "Get participant from a call.", + "description": "Get participant from a call.", + "operationId": "CallConnection_GetParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection Id", + "required": true, + "type": "string" + }, + { + "name": "participantRawId", + "in": "path", + "description": "Raw id of the participant to retrieve.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "200": { + "description": "Returns the detail of the requested participant.", + "schema": { + "$ref": "#/definitions/CallParticipant" + } + } + }, + "x-ms-examples": { + "CallConnection_GetParticipant": { + "$ref": "./examples/CallConnection_GetParticipant.json" + } + } + } + }, + "/calling/recordings": { + "post": { + "tags": [ + "Recording" + ], + "summary": "Start recording the call.", + "operationId": "CallRecording_StartRecording", + "parameters": [ + { + "name": "startCallRecording", + "in": "body", + "description": "The request body of start call recording request.", + "required": true, + "schema": { + "$ref": "#/definitions/StartCallRecordingRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "200": { + "description": "Returns the start call recording response.", + "schema": { + "$ref": "#/definitions/RecordingStateResponse" + } + } + }, + "x-ms-examples": { + "CallRecording_StartRecording": { + "$ref": "./examples/CallRecording_StartRecording.json" + } + } + } + }, + "/calling/recordings/{recordingId}": { + "get": { + "tags": [ + "Recording" + ], + "summary": "Get call recording properties.", + "operationId": "CallRecording_GetRecordingProperties", + "parameters": [ + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "200": { + "description": "Returns the recording properties.", + "schema": { + "$ref": "#/definitions/RecordingStateResponse" + } + } + }, + "x-ms-examples": { + "CallRecording_GetRecordingProperties": { + "$ref": "./examples/CallRecording_GetRecordingProperties.json" + } + } + }, + "delete": { + "tags": [ + "Recording" + ], + "summary": "Stop recording the call.", + "operationId": "CallRecording_StopRecording", + "parameters": [ + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "204": { + "description": "Returns the stop call recording response." + } + }, + "x-ms-examples": { + "CallRecording_StopRecording": { + "$ref": "./examples/CallRecording_StopRecording.json" + } + } + } + }, + "/calling/recordings/{recordingId}:pause": { + "post": { + "tags": [ + "Recording" + ], + "summary": "Pause recording the call.", + "operationId": "CallRecording_PauseRecording", + "parameters": [ + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "202": { + "description": "The service has accepted the pause request and will begin processing it." + } + }, + "x-ms-examples": { + "CallRecording_PauseRecording": { + "$ref": "./examples/CallRecording_PauseRecording.json" + } + } + } + }, + "/calling/recordings/{recordingId}:resume": { + "post": { + "tags": [ + "Recording" + ], + "summary": "Resume recording the call.", + "operationId": "CallRecording_ResumeRecording", + "parameters": [ + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + }, + "202": { + "description": "The service has accepted the resume request and will begin processing it." + } + }, + "x-ms-examples": { + "CallRecording_ResumeRecording": { + "$ref": "./examples/CallRecording_ResumeRecording.json" + } + } + } + } + }, + "definitions": { + "CreateCallRequest": { + "description": "The request payload for creating the call.", + "required": [ + "targets", + "callbackUri" + ], + "type": "object", + "properties": { + "targets": { + "description": "The targets of the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "sourceCallerIdNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel", + "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when calling a PSTN callee." + }, + "sourceDisplayName": { + "description": "Display name of the call if dialing out to a pstn number", + "type": "string" + }, + "source": { + "$ref": "#/definitions/CommunicationUserIdentifierModel", + "description": "The identifier of the source of the call" + }, + "operationContext": { + "description": "A customer set value used to track the answering of a call.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI.", + "type": "string" + }, + "callIntelligenceOptions": { + "$ref": "#/definitions/CallIntelligenceOptions", + "description": "AI options for the call." + } + } + }, + "CommunicationIdentifierModel": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationIdentifierModel" + }, + "PhoneNumberIdentifierModel": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/PhoneNumberIdentifierModel" + }, + "CommunicationUserIdentifierModel": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationUserIdentifierModel" + }, + "CallIntelligenceOptions": { + "description": "AI options for the call.", + "type": "object", + "properties": { + "cognitiveServicesEndpoint": { + "description": "The identifier of the Cognitive Service resource assigned to this call.", + "type": "string" + } + } + }, + "CommunicationErrorResponse": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse" + }, + "CallConnectionStateModel": { + "description": "The state of the call connection.", + "enum": [ + "unknown", + "connecting", + "connected", + "transferring", + "transferAccepted", + "disconnecting", + "disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "CallConnectionStateModel", + "modelAsString": true + } + }, + "CallConnectionProperties": { + "description": "Properties of a call connection", + "type": "object", + "properties": { + "callConnectionId": { + "description": "The call connection id.", + "type": "string" + }, + "serverCallId": { + "description": "The server call id.", + "type": "string" + }, + "targets": { + "description": "The targets of the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "callConnectionState": { + "$ref": "#/definitions/CallConnectionStateModel" + }, + "callbackUri": { + "description": "The callback URI.", + "type": "string" + }, + "sourceCallerIdNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel", + "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when calling a PSTN callee." + }, + "sourceDisplayName": { + "description": "Display name of the call if dialing out to a pstn number.", + "type": "string" + }, + "source": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Source identity." + }, + "correlationId": { + "description": "The correlation ID.", + "type": "string" + }, + "answeredBy": { + "$ref": "#/definitions/CommunicationUserIdentifierModel", + "description": "Identity of the answering entity. Only populated when identity is provided in the request." + } + } + }, + "AnswerCallRequest": { + "description": "The request payload for answering the call.", + "required": [ + "incomingCallContext", + "callbackUri" + ], + "type": "object", + "properties": { + "incomingCallContext": { + "description": "The context associated with the call.", + "type": "string" + }, + "callbackUri": { + "description": "The callback uri.", + "type": "string" + }, + "operationContext": { + "description": "A customer set value used to track the answering of a call.", + "type": "string" + }, + "callIntelligenceOptions": { + "$ref": "#/definitions/CallIntelligenceOptions", + "description": "AI options for the call." + }, + "answeredBy": { + "$ref": "#/definitions/CommunicationUserIdentifierModel", + "description": "The identifier of the call automation entity which answers the call" + } + } + }, + "RedirectCallRequest": { + "description": "The request payload for redirecting the call.", + "required": [ + "incomingCallContext", + "target" + ], + "type": "object", + "properties": { + "incomingCallContext": { + "description": "The context associated with the call.", + "type": "string" + }, + "target": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The target identity to redirect the call to." + } + } + }, + "CallRejectReason": { + "description": "The rejection reason.", + "enum": [ + "none", + "busy", + "forbidden" + ], + "type": "string", + "x-ms-enum": { + "name": "CallRejectReason", + "modelAsString": true + } + }, + "RejectCallRequest": { + "description": "The request payload for rejecting the call.", + "required": [ + "incomingCallContext" + ], + "type": "object", + "properties": { + "incomingCallContext": { + "description": "The context associated with the call.", + "type": "string" + }, + "callRejectReason": { + "$ref": "#/definitions/CallRejectReason" + } + } + }, + "TransferToParticipantRequest": { + "description": "The request payload for transferring call to a participant.", + "required": [ + "targetParticipant" + ], + "type": "object", + "properties": { + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The identity of the target where call should be transferred to." + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "transferee": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Transferee is the participant who is transferred away." + }, + "operationCallbackUri": { + "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.", + "type": "string" + }, + "customCallingContext": { + "$ref": "#/definitions/CustomCallingContext", + "description": "Used by customer to send custom calling context to targets" + } + } + }, + "CustomCallingContext": { + "description": "The custom calling context which will be sent to the target", + "type": "object", + "properties": { + "voipHeaders": { + "description": "Custom calling context VoiP headers", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sipHeaders": { + "description": "Custom calling context SIP headers", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TransferCallResponse": { + "description": "The response payload for transferring the call.", + "type": "object", + "properties": { + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + } + }, + "PlayRequest": { + "required": [ + "playSources" + ], + "type": "object", + "properties": { + "playSources": { + "description": "The source of the audio to be played.", + "type": "array", + "items": { + "$ref": "#/definitions/PlaySource" + } + }, + "playTo": { + "description": "The list of call participants play provided audio to.\r\nPlays to everyone in the call when not provided.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "playOptions": { + "$ref": "#/definitions/PlayOptions", + "description": "Defines options for playing the audio." + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + }, + "operationCallbackUri": { + "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.", + "type": "string" + } + } + }, + "PlaySourceType": { + "description": "Defines the type of the play source", + "enum": [ + "file", + "text", + "ssml" + ], + "type": "string", + "x-ms-enum": { + "name": "PlaySourceType", + "modelAsString": true + } + }, + "PlaySource": { + "required": [ + "kind" + ], + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/PlaySourceType" + }, + "playSourceCacheId": { + "description": "Defines the identifier to be used for caching related media", + "type": "string" + }, + "file": { + "$ref": "#/definitions/FileSource", + "description": "Defines the file source info to be used for play" + }, + "text": { + "$ref": "#/definitions/TextSource", + "description": "Defines the text source info to be used for play" + }, + "ssml": { + "$ref": "#/definitions/SsmlSource", + "description": "Defines the ssml(Speech Synthesis Markup Language) source info to be used for play" + } + } + }, + "PlayOptions": { + "required": [ + "loop" + ], + "type": "object", + "properties": { + "loop": { + "description": "The option to play the provided audio source in loop when set to true", + "type": "boolean" + } + } + }, + "FileSource": { + "required": [ + "uri" + ], + "type": "object", + "properties": { + "uri": { + "description": "Uri for the audio file to be played", + "type": "string" + } + } + }, + "VoiceKind": { + "description": "Voice kind type", + "enum": [ + "male", + "female" + ], + "type": "string", + "x-ms-enum": { + "name": "VoiceKind", + "modelAsString": true + } + }, + "TextSource": { + "required": [ + "text" + ], + "type": "object", + "properties": { + "text": { + "description": "Text for the cognitive service to be played", + "type": "string" + }, + "sourceLocale": { + "description": "Source language locale to be played\r\nRefer to available locales here: ", + "type": "string" + }, + "voiceKind": { + "$ref": "#/definitions/VoiceKind" + }, + "voiceName": { + "description": "Voice name to be played\r\nRefer to available Text-to-speech voices here: ", + "type": "string" + }, + "customVoiceEndpointId": { + "description": "Endpoint where the custom voice was deployed.", + "type": "string" + } + } + }, + "SsmlSource": { + "required": [ + "ssmlText" + ], + "type": "object", + "properties": { + "ssmlText": { + "description": "Ssml string for the cognitive service to be played", + "type": "string" + }, + "customVoiceEndpointId": { + "description": "Endpoint where the custom voice was deployed.", + "type": "string" + } + } + }, + "RecognizeInputType": { + "description": "Determines the type of the recognition.", + "enum": [ + "dtmf", + "speech", + "speechOrDtmf", + "choices" + ], + "type": "string", + "x-ms-enum": { + "name": "RecognizeInputType", + "modelAsString": true + } + }, + "RecognizeRequest": { + "required": [ + "recognizeInputType", + "recognizeOptions" + ], + "type": "object", + "properties": { + "recognizeInputType": { + "$ref": "#/definitions/RecognizeInputType" + }, + "playPrompt": { + "$ref": "#/definitions/PlaySource", + "description": "The source of the audio to be played for recognition." + }, + "interruptCallMediaOperation": { + "description": "If set recognize can barge into other existing queued-up/currently-processing requests.", + "type": "boolean" + }, + "recognizeOptions": { + "$ref": "#/definitions/RecognizeOptions", + "description": "Defines options for recognition." + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + }, + "operationCallbackUri": { + "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.", + "type": "string" + } + } + }, + "RecognizeOptions": { + "required": [ + "targetParticipant" + ], + "type": "object", + "properties": { + "interruptPrompt": { + "description": "Determines if we interrupt the prompt and start recognizing.", + "type": "boolean" + }, + "initialSilenceTimeoutInSeconds": { + "format": "int32", + "description": "Time to wait for first input after prompt (if any).", + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Target participant of DTMF tone recognition." + }, + "speechLanguage": { + "description": "Speech language to be recognized, If not set default is en-US", + "type": "string" + }, + "speechRecognitionModelEndpointId": { + "description": "Endpoint where the custom model was deployed.", + "type": "string" + }, + "dtmfOptions": { + "$ref": "#/definitions/DtmfOptions", + "description": "Defines configurations for DTMF." + }, + "choices": { + "description": "Defines Ivr choices for recognize.", + "type": "array", + "items": { + "$ref": "#/definitions/Choice" + } + }, + "speechOptions": { + "$ref": "#/definitions/SpeechOptions", + "description": "Defines continuous speech recognition option." + } + } + }, + "Tone": { + "enum": [ + "zero", + "one", + "two", + "three", + "four", + "five", + "six", + "seven", + "eight", + "nine", + "a", + "b", + "c", + "d", + "pound", + "asterisk" + ], + "type": "string", + "x-ms-enum": { + "name": "Tone", + "modelAsString": true + } + }, + "DtmfOptions": { + "description": "Options for DTMF recognition", + "type": "object", + "properties": { + "interToneTimeoutInSeconds": { + "format": "int32", + "description": "Time to wait between DTMF inputs to stop recognizing.", + "maximum": 60, + "minimum": 1, + "type": "integer" + }, + "maxTonesToCollect": { + "format": "int32", + "description": "Maximum number of DTMF tones to be collected.", + "type": "integer" + }, + "stopTones": { + "description": "List of tones that will stop recognizing.", + "type": "array", + "items": { + "$ref": "#/definitions/Tone" + } + } + } + }, + "Choice": { + "required": [ + "label", + "phrases" + ], + "type": "object", + "properties": { + "label": { + "description": "Identifier for a given choice", + "type": "string" + }, + "phrases": { + "description": "List of phrases to recognize", + "type": "array", + "items": { + "type": "string" + } + }, + "tone": { + "$ref": "#/definitions/Tone" + } + } + }, + "SpeechOptions": { + "description": "Options for continuous speech recognition", + "type": "object", + "properties": { + "endSilenceTimeoutInMs": { + "format": "int64", + "description": "The length of end silence when user stops speaking and cogservice send response.", + "type": "integer" + } + } + }, + "ContinuousDtmfRecognitionRequest": { + "required": [ + "targetParticipant" + ], + "type": "object", + "properties": { + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Defines options for recognition." + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + }, + "operationCallbackUri": { + "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.", + "type": "string" + } + } + }, + "SendDtmfTonesRequest": { + "required": [ + "tones", + "targetParticipant" + ], + "type": "object", + "properties": { + "tones": { + "description": "List of tones to be sent to target participant.", + "type": "array", + "items": { + "$ref": "#/definitions/Tone" + } + }, + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Target participant of send Dtmf tones." + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + }, + "operationCallbackUri": { + "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.", + "type": "string" + } + } + }, + "SendDtmfTonesResult": { + "type": "object", + "properties": { + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + } + }, + "GetParticipantsResponse": { + "description": "The response payload for getting participants of the call.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "List of the current participants in the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CallParticipant" + } + }, + "nextLink": { + "description": "Continue of the list of participants", + "type": "string" + } + } + }, + "CallParticipant": { + "description": "A call participant.", + "type": "object", + "properties": { + "identifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Communication identifier of the participant" + }, + "isMuted": { + "description": "Is participant muted", + "type": "boolean" + } + } + }, + "AddParticipantRequest": { + "description": "The request payload for adding participant to the call.", + "required": [ + "participantToAdd" + ], + "type": "object", + "properties": { + "sourceCallerIdNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel", + "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when inviting a PSTN participant." + }, + "sourceDisplayName": { + "description": "(Optional) The display name of the source that is associated with this invite operation when\r\nadding a PSTN participant or teams user. Note: Will not update the display name in the roster.", + "type": "string" + }, + "participantToAdd": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The participant to invite." + }, + "invitationTimeoutInSeconds": { + "format": "int32", + "description": "Gets or sets the timeout to wait for the invited participant to pickup.\r\nThe maximum value of this is 180 seconds", + "maximum": 180, + "minimum": 0, + "type": "integer" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "operationCallbackUri": { + "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.", + "type": "string" + }, + "customCallingContext": { + "$ref": "#/definitions/CustomCallingContext", + "description": "Used by customer to send custom calling context to targets" + } + } + }, + "AddParticipantResponse": { + "description": "The response payload for adding participants to the call.", + "type": "object", + "properties": { + "participant": { + "$ref": "#/definitions/CallParticipant", + "description": "List of current participants in the call." + }, + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + }, + "invitationId": { + "description": "Invitation ID used to add a participant.", + "type": "string" + } + } + }, + "RemoveParticipantRequest": { + "description": "The remove participant by identifier request.", + "required": [ + "participantToRemove" + ], + "type": "object", + "properties": { + "participantToRemove": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The participants to be removed from the call." + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "operationCallbackUri": { + "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.", + "type": "string" + } + } + }, + "RemoveParticipantResponse": { + "description": "The response payload for removing participants of the call.", + "type": "object", + "properties": { + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + } + }, + "MuteParticipantsRequest": { + "description": "The request payload for muting participants from the call.", + "required": [ + "targetParticipants" + ], + "type": "object", + "properties": { + "targetParticipants": { + "description": "Participants to be muted from the call.\r\nOnly ACS Users are supported.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "MuteParticipantsResult": { + "description": "The result payload for muting participants from the call.", + "type": "object", + "properties": { + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + } + }, + "CancelAddParticipantRequest": { + "description": "Request payload for cancelling add participant request.", + "required": [ + "invitationId" + ], + "type": "object", + "properties": { + "invitationId": { + "description": "Invitation ID used to add a participant.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "operationCallbackUri": { + "description": "Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.\r\nThis setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.", + "type": "string" + } + } + }, + "CancelAddParticipantResponse": { + "description": "Response payload for cancel add participant request.", + "type": "object", + "properties": { + "invitationId": { + "description": "Invitation ID used to cancel the add participant action.", + "type": "string" + }, + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + } + }, + "RecordingContentType": { + "description": "The content type of call recording.", + "enum": [ + "audio", + "audioVideo" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingContentType", + "modelAsString": true + } + }, + "RecordingChannelType": { + "description": "The channel type of call recording.", + "enum": [ + "mixed", + "unmixed" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingChannelType", + "modelAsString": true + } + }, + "RecordingFormatType": { + "description": "The format type of call recording.", + "enum": [ + "wav", + "mp3", + "mp4" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingFormatType", + "modelAsString": true + } + }, + "StartCallRecordingRequest": { + "description": "The request payload start for call recording operation with call locator.", + "required": [ + "callLocator" + ], + "type": "object", + "properties": { + "callLocator": { + "$ref": "#/definitions/CallLocator", + "description": "The call locator." + }, + "recordingStateCallbackUri": { + "description": "The uri to send notifications to.", + "type": "string" + }, + "recordingContentType": { + "$ref": "#/definitions/RecordingContentType" + }, + "recordingChannelType": { + "$ref": "#/definitions/RecordingChannelType" + }, + "recordingFormatType": { + "$ref": "#/definitions/RecordingFormatType" + }, + "audioChannelParticipantOrdering": { + "description": "The sequential order in which audio channels are assigned to participants in the unmixed recording.\r\nWhen 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering is not specified,\r\nthe audio channel to participant mapping will be automatically assigned based on the order in which participant\r\nfirst audio was detected. Channel to participant mapping details can be found in the metadata of the recording.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "channelAffinity": { + "description": "The channel affinity of call recording\r\nWhen 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned.\r\nChannel-Participant mapping details can be found in the metadata of the recording.\r\n///", + "type": "array", + "items": { + "$ref": "#/definitions/ChannelAffinity" + } + } + } + }, + "CallLocatorKind": { + "description": "The call locator kind.", + "enum": [ + "groupCallLocator", + "serverCallLocator" + ], + "type": "string", + "x-ms-enum": { + "name": "CallLocatorKind", + "modelAsString": true + } + }, + "CallLocator": { + "description": "The locator used for joining or taking action on a call.", + "type": "object", + "properties": { + "groupCallId": { + "description": "The group call id", + "type": "string" + }, + "serverCallId": { + "description": "The server call id.", + "type": "string" + }, + "kind": { + "$ref": "#/definitions/CallLocatorKind" + } + } + }, + "ChannelAffinity": { + "description": "Channel affinity for a participant", + "required": [ + "participant" + ], + "type": "object", + "properties": { + "channel": { + "format": "int32", + "description": "Channel number to which bitstream from a particular participant will be written.", + "maximum": 4, + "minimum": 0, + "type": "integer" + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The identifier for the participant whose bitstream will be written to the channel \r\nrepresented by the channel number." + } + } + }, + "RecordingState": { + "enum": [ + "active", + "inactive" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingState", + "modelAsString": true + } + }, + "RecordingStateResponse": { + "type": "object", + "properties": { + "recordingId": { + "type": "string" + }, + "recordingState": { + "$ref": "#/definitions/RecordingState" + } + } + }, + "AddParticipantFailed": { + "description": "The failed to add participants event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Participant" + } + } + }, + "ResultInformation": { + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "Code of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected.", + "type": "integer" + }, + "subCode": { + "format": "int32", + "description": "Subcode of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected.", + "type": "integer" + }, + "message": { + "description": "Detail message that describes the current result.", + "type": "string" + } + } + }, + "AddParticipantSucceeded": { + "description": "The participants successfully added event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Participant" + } + } + }, + "CallConnected": { + "description": "The call connected event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers to set the context for creating a new call. This property will be null for answering a call.", + "type": "string" + } + } + }, + "CallDisconnected": { + "description": "The call disconnected event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers to set the context for creating a new call. This property will be null for answering a call.", + "type": "string" + } + } + }, + "CallTransferAccepted": { + "description": "The call transfer accepted event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "transferTarget": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Target who the call is transferred to." + }, + "transferee": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "the participant who is being transferred away." + } + } + }, + "CallTransferFailed": { + "description": "The call transfer failed event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "ParticipantsUpdated": { + "description": "The participants updated in a call event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "sequenceNumber": { + "format": "int32", + "description": "The Sequence Number of the event", + "type": "integer" + }, + "participants": { + "description": "The list of participants in the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CallParticipant" + } + } + } + }, + "RemoveParticipantSucceeded": { + "description": "The participant removed event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Participant" + } + } + }, + "RemoveParticipantFailed": { + "description": "The failed to remove participant event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Participant" + } + } + }, + "CancelAddParticipantSucceeded": { + "description": "Successful cancel add participant event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "invitationId": { + "description": "Invitation ID used to cancel the request.", + "type": "string" + } + } + }, + "CancelAddParticipantFailed": { + "description": "Failed cancel add participant event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services." + }, + "invitationId": { + "description": "Invitation ID used to cancel the request.", + "type": "string" + } + } + }, + "RecordingStateChanged": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "recordingId": { + "description": "The call recording id", + "type": "string", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/RecordingState" + }, + "startDateTime": { + "format": "date-time", + "description": "The time of the recording started", + "type": "string", + "readOnly": true + } + } + }, + "PlayCompleted": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "PlayFailed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "PlayCanceled": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "RecognitionType": { + "description": "Determines the sub-type of the recognize operation.\r\nIn case of cancel operation the this field is not set and is returned empty", + "enum": [ + "dtmf", + "speech", + "choices" + ], + "type": "string", + "x-ms-enum": { + "name": "RecognitionType", + "modelAsString": true + } + }, + "RecognizeCompleted": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "recognitionType": { + "$ref": "#/definitions/RecognitionType" + }, + "dtmfResult": { + "$ref": "#/definitions/DtmfResult", + "description": "Defines the result for RecognitionType = Dtmf" + }, + "choiceResult": { + "$ref": "#/definitions/ChoiceResult", + "description": "Defines the result for RecognitionType = Choices" + }, + "speechResult": { + "$ref": "#/definitions/SpeechResult", + "description": "Defines the result for RecognitionType = Speech and SpeechOrDtmf", + "readOnly": true + } + } + }, + "DtmfResult": { + "type": "object", + "properties": { + "tones": { + "type": "array", + "items": { + "$ref": "#/definitions/Tone" + }, + "readOnly": true + } + } + }, + "ChoiceResult": { + "type": "object", + "properties": { + "label": { + "description": "Label is the primary identifier for the choice detected", + "type": "string" + }, + "recognizedPhrase": { + "description": "Phrases are set to the value if choice is selected via phrase detection.\r\nIf Dtmf input is recognized, then Label will be the identifier for the choice detected and phrases will be set to null", + "type": "string" + } + } + }, + "SpeechResult": { + "description": "The speech status as a result.", + "type": "object", + "properties": { + "speech": { + "description": "The recognized speech in string.", + "type": "string" + } + } + }, + "RecognizeFailed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "RecognizeCanceled": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "ContinuousDtmfRecognitionToneFailed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "ContinuousDtmfRecognitionToneReceived": { + "type": "object", + "properties": { + "sequenceId": { + "format": "int32", + "description": "The sequence id which can be used to determine if the same tone was played multiple times or if any tones were missed.", + "type": "integer", + "readOnly": true + }, + "tone": { + "$ref": "#/definitions/Tone" + }, + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId or skype chain ID.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "ContinuousDtmfRecognitionStopped": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "SendDtmfTonesCompleted": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "SendDtmfTonesFailed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of API to invoke.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "name": "endpoint", + "in": "path", + "description": "The endpoint of the Azure Communication resource.", + "required": true, + "type": "string", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "Authorization": { + "type": "apiKey", + "description": "An Azure Communication Services user access token.", + "name": "Authorization", + "in": "header" + } + }, + "security": [ + { + "Authorization": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/AnswerCall.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/AnswerCall.json new file mode 100644 index 000000000000..9e99cc76f422 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/AnswerCall.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "answerCallRequest": { + "incomingCallContext": "H4sIAAAAAAAEAMVVS2/bOBD+LzrspaElPiSSBoJFNnvYoNi0aHaBtpcFRQ5t1rIokLRTJ8h/X1J2soHRQ4A9lAdZ4ry+mflm/FhpNQy3PjnrtErOj9XysbLBb8uvM9WyEkul49J2ioEiGhlKADHVKiR7oVDXUGo5tkpa8k8zH9yglhuKuLQNkqLpEMZUNSZLNFfVRWVcnAZ1uFVbyP53EQLOtzCaybsx3ZSgnZFKKk4QgLGIybZFfU8oolIZzFrWGk6yzaDG1U6tYLaBMd9MKiSn3aROjjSRoAUHhG1PEDMdIGFlg4yRUmhChWQsm62dMdl+adUQ4aIKEP0u6KPft6RePV1Uyf/PmmmT5VijnlmMpD7VDLg4r9m4G4azgjWng37weD5nBTt6OS8YlcRyBhpJwD1iggFSbccQJVRJANW1gp4XLCc/uHETS/4qJaXX2dE6pSku61pNbgETMrBfxM1hgsUIqVzWe1Lrqda6iBBpmsXx9ZWW1vUe19aHDZja9pqBMRyBpQyxriVIgNBIGa11D9wy2tWE1Q7np6iPOH51lyXtLRinrsZ4D6FwQmdY28LEKfhV7nX8+XCfkZwAB/gGOv18WEccJ1A7M/0V1BgnHwq0/JmBYSoWEi84XTC+pIyLuszCXPBrPyYY0zPTsv57OBSOxJxoXjXzV3WzJs1D/+X22gy/36m762/vhk8PV5eXOWAm5gZKqDZ5/PCdc2L/vvmjbynGh3fhPus8lVIZFzLI7PBj8BNkOsPMRBc/nURXw+DvIbM7hR3MJnmWdNE6Itt7p2Gr3HAHKblxVcyfsp724x5CnPfizbh36WVDvpaUNIMfhplbb+1Xtp87hhfPr687lq/qB4HD9ec1vN98+OzhQ9Rfp26zKq34BS47ygVtBZdNS3AjMCnb0MU/d0NyH/NEH15WmYu/BZ+7q2L6b1oN9LvVS3se5z+B4w6lWIOSHOl5+rmiSJoOI9b0jZZATMPUD7bsm5ZGjrsKfjfNcb+faPH0LyoNW7KCBgAA", + "callbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "200": { + "body": { + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "sourceCallerIdNumber": { + "value": "+18440123456" + }, + "source": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + }, + "targets": [ + { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9" + } + } + ], + "callConnectionState": "connected", + "callbackUri": "https://app.contoso.com/callback" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_AddParticipant.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_AddParticipant.json new file mode 100644 index 000000000000..5ee39f6b19b6 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_AddParticipant.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "addParticipantRequest": { + "participantToAdd": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538" + } + }, + "operationContext": "adding participant", + "sourceCallerIdNumber": { + "value": "+18440123456" + }, + "operationCallbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "202": { + "body": { + "operationContext": "adding participant", + "participant": { + "identifier": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538" + } + }, + "isMuted": false + }, + "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_CancelAddParticipant.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_CancelAddParticipant.json new file mode 100644 index 000000000000..7261fd42faa0 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_CancelAddParticipant.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "cancelAddParticipantRequest": { + "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40", + "operationContext": "cancelling add participant", + "operationCallbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "202": { + "body": { + "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40", + "operationContext": "cancelling add participant" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_GetCall.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_GetCall.json new file mode 100644 index 000000000000..9b163c9495ea --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_GetCall.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c" + }, + "responses": { + "200": { + "body": { + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "sourceCallerIdNumber": { + "value": "+18440123456" + }, + "source": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + }, + "targets": [ + { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9" + } + }, + { + "kind": "phoneNumber", + "phoneNumber": { + "value": "+14250123456" + } + } + ], + "callConnectionState": "connected", + "callbackUri": "https://app.contoso.com/callback" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_GetParticipant.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_GetParticipant.json new file mode 100644 index 000000000000..c92cc572b7d7 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_GetParticipant.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "participantRawId": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + }, + "responses": { + "200": { + "body": { + "identifier": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + }, + "isMuted": false + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_GetParticipants.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_GetParticipants.json new file mode 100644 index 000000000000..03dd1197b5f0 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_GetParticipants.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identifier": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + }, + "isMuted": true + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_HangupCall.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_HangupCall.json new file mode 100644 index 000000000000..32c65d22f31d --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_HangupCall.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c" + }, + "responses": { + "204": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_Mute.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_Mute.json new file mode 100644 index 000000000000..8dac3a6ec771 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_Mute.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "muteParticipantsRequest": { + "targetParticipants": [ + { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + } + ], + "operationContext": "mute participant" + } + }, + "responses": { + "200": { + "body": { + "operationContext": "mute participant" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_RemoveParticipant.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_RemoveParticipant.json new file mode 100644 index 000000000000..f6da4fbb1a26 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_RemoveParticipant.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "removeParticipantRequest": { + "participantToRemove": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538" + } + }, + "operationContext": "removing participant", + "operationCallbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "202": { + "body": { + "operationContext": "removing participant" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_TerminateCall.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_TerminateCall.json new file mode 100644 index 000000000000..32c65d22f31d --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_TerminateCall.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c" + }, + "responses": { + "204": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_TransferToParticipant.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_TransferToParticipant.json new file mode 100644 index 000000000000..2823275896d7 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallConnection_TransferToParticipant.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "transferToParticipantRequest": { + "targetParticipant": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + }, + "transferee": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538" + } + }, + "operationCallbackUri": "https://app.contoso.com/callback", + "operationContext": "trasferring call" + } + }, + "responses": { + "202": { + "body": { + "operationContext": "trasferring call" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_CancelAllMediaOperations.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_CancelAllMediaOperations.json new file mode 100644 index 000000000000..9fdfced8a11e --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_CancelAllMediaOperations.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c" + }, + "responses": { + "202": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_Play.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_Play.json new file mode 100644 index 000000000000..672bff695110 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_Play.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "playRequest": { + "playSources": [ + { + "kind": "file", + "playSourceCacheId": "string", + "file": { + "uri": "https://some.file.azure.com/sample.wav" + } + } + ], + "playTo": [ + { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538" + } + } + ], + "playOptions": { + "loop": true + }, + "operationCallbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_Recognize.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_Recognize.json new file mode 100644 index 000000000000..4fa23ae9b84f --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_Recognize.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "recognizeRequest": { + "recognizeInputType": "dtmf", + "playPrompt": { + "kind": "file", + "file": { + "uri": "https://some.file.azure.com/sample.wav" + } + }, + "recognizeOptions": { + "interruptPrompt": true, + "initialSilenceTimeoutInSeconds": 5, + "targetParticipant": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + }, + "dtmfOptions": { + "interToneTimeoutInSeconds": 3, + "maxTonesToCollect": 5, + "stopTones": [ + "pound" + ] + } + }, + "operationCallbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_SendDtmfTones.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_SendDtmfTones.json new file mode 100644 index 000000000000..5436188f4718 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_SendDtmfTones.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "sendDtmfTonesRequest": { + "tones": [ + "zero" + ], + "targetParticipant": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + }, + "operationContext": "sendDtmf operation context", + "operationCallbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "202": { + "body": { + "operationContext": "sendDtmf operation context" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_StartContinuousDtmfRecognition.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_StartContinuousDtmfRecognition.json new file mode 100644 index 000000000000..e2303329d3db --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_StartContinuousDtmfRecognition.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "continuousDtmfRecognitionRequest": { + "targetParticipant": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_StopContinuousDtmfRecognition.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_StopContinuousDtmfRecognition.json new file mode 100644 index 000000000000..394cca251570 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallMedia_StopContinuousDtmfRecognition.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "continuousDtmfRecognitionRequest": { + "targetParticipant": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + }, + "operationCallbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_GetRecordingProperties.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_GetRecordingProperties.json new file mode 100644 index 000000000000..6506d7da73d8 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_GetRecordingProperties.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ==" + }, + "responses": { + "200": { + "body": { + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ==", + "recordingState": "inactive" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_PauseRecording.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_PauseRecording.json new file mode 100644 index 000000000000..252ca159c70e --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_PauseRecording.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ==" + }, + "responses": { + "202": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_ResumeRecording.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_ResumeRecording.json new file mode 100644 index 000000000000..252ca159c70e --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_ResumeRecording.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ==" + }, + "responses": { + "202": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_StartRecording.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_StartRecording.json new file mode 100644 index 000000000000..ce2fb26f5c05 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_StartRecording.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "startCallRecording": { + "recordingStateCallbackUri": "https://contoso.communications.azure.com/callback", + "recordingContentType": null, + "recordingChannelType": null, + "recordingFormatType": null, + "callLocator": { + "serverCallId": "aHR0cHM6Ly9za3lwZS5uZXQvYXBpL3YyL2NwL3NreXBlLm5ldC9jb252LzFQd3ZKMTcxZFI/aT0wJmU9NzU3NzA4NzU3OQ==", + "kind": "serverCallLocator" + } + } + }, + "responses": { + "200": { + "body": { + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ==", + "recordingState": "inactive" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_StopRecording.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_StopRecording.json new file mode 100644 index 000000000000..42ad201eea04 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CallRecording_StopRecording.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "recordingId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUiLCJSZXNvdXJjZVNwZWNpZmljSWQiOiI4YjlkYmFkMS0xOGFiLTRmODYtYWQ0Yy1jNzVmODA5ODA3NmUifQ==" + }, + "responses": { + "204": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CreateCall.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CreateCall.json new file mode 100644 index 000000000000..7c2dad9588c1 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/CreateCall.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "createCallRequest": { + "targets": [ + { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9" + } + } + ], + "callbackUri": "https://app.contoso.com/callback" + } + }, + "responses": { + "201": { + "body": { + "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c", + "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA", + "source": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce" + } + }, + "targets": [ + { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9" + } + } + ], + "callConnectionState": "connected", + "callbackUri": "https://app.contoso.com/callback" + } + } + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/RedirectCall.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/RedirectCall.json new file mode 100644 index 000000000000..ce4acb4a6ab3 --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/RedirectCall.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "redirectCallRequest": { + "target": { + "kind": "communicationUser", + "communicationUser": { + "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9" + } + }, + "incomingCallContext": "H4sIAAAAAAAEAMVVS2/bOBD+LzrspaElPiSSBoJFNnvYoNi0aHaBtpcFRQ5t1rIokLRTJ8h/X1J2soHRQ4A9lAdZ4ry+mflm/FhpNQy3PjnrtErOj9XysbLBb8uvM9WyEkul49J2ioEiGhlKADHVKiR7oVDXUGo5tkpa8k8zH9yglhuKuLQNkqLpEMZUNSZLNFfVRWVcnAZ1uFVbyP53EQLOtzCaybsx3ZSgnZFKKk4QgLGIybZFfU8oolIZzFrWGk6yzaDG1U6tYLaBMd9MKiSn3aROjjSRoAUHhG1PEDMdIGFlg4yRUmhChWQsm62dMdl+adUQ4aIKEP0u6KPft6RePV1Uyf/PmmmT5VijnlmMpD7VDLg4r9m4G4azgjWng37weD5nBTt6OS8YlcRyBhpJwD1iggFSbccQJVRJANW1gp4XLCc/uHETS/4qJaXX2dE6pSku61pNbgETMrBfxM1hgsUIqVzWe1Lrqda6iBBpmsXx9ZWW1vUe19aHDZja9pqBMRyBpQyxriVIgNBIGa11D9wy2tWE1Q7np6iPOH51lyXtLRinrsZ4D6FwQmdY28LEKfhV7nX8+XCfkZwAB/gGOv18WEccJ1A7M/0V1BgnHwq0/JmBYSoWEi84XTC+pIyLuszCXPBrPyYY0zPTsv57OBSOxJxoXjXzV3WzJs1D/+X22gy/36m762/vhk8PV5eXOWAm5gZKqDZ5/PCdc2L/vvmjbynGh3fhPus8lVIZFzLI7PBj8BNkOsPMRBc/nURXw+DvIbM7hR3MJnmWdNE6Itt7p2Gr3HAHKblxVcyfsp724x5CnPfizbh36WVDvpaUNIMfhplbb+1Xtp87hhfPr687lq/qB4HD9ec1vN98+OzhQ9Rfp26zKq34BS47ygVtBZdNS3AjMCnb0MU/d0NyH/NEH15WmYu/BZ+7q2L6b1oN9LvVS3se5z+B4w6lWIOSHOl5+rmiSJoOI9b0jZZATMPUD7bsm5ZGjrsKfjfNcb+faPH0LyoNW7KCBgAA" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/RejectCall.json b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/RejectCall.json new file mode 100644 index 000000000000..5870911cd62b --- /dev/null +++ b/specification/communication/data-plane/CallAutomation/stable/2023-10-15/examples/RejectCall.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "https://contoso.communications.azure.com", + "api-version": "2023-10-15", + "rejectCallRequest": { + "incomingCallContext": "H4sIAAAAAAAEAMVVS2/bOBD+LzrspaElPiSSBoJFNnvYoNi0aHaBtpcFRQ5t1rIokLRTJ8h/X1J2soHRQ4A9lAdZ4ry+mflm/FhpNQy3PjnrtErOj9XysbLBb8uvM9WyEkul49J2ioEiGhlKADHVKiR7oVDXUGo5tkpa8k8zH9yglhuKuLQNkqLpEMZUNSZLNFfVRWVcnAZ1uFVbyP53EQLOtzCaybsx3ZSgnZFKKk4QgLGIybZFfU8oolIZzFrWGk6yzaDG1U6tYLaBMd9MKiSn3aROjjSRoAUHhG1PEDMdIGFlg4yRUmhChWQsm62dMdl+adUQ4aIKEP0u6KPft6RePV1Uyf/PmmmT5VijnlmMpD7VDLg4r9m4G4azgjWng37weD5nBTt6OS8YlcRyBhpJwD1iggFSbccQJVRJANW1gp4XLCc/uHETS/4qJaXX2dE6pSku61pNbgETMrBfxM1hgsUIqVzWe1Lrqda6iBBpmsXx9ZWW1vUe19aHDZja9pqBMRyBpQyxriVIgNBIGa11D9wy2tWE1Q7np6iPOH51lyXtLRinrsZ4D6FwQmdY28LEKfhV7nX8+XCfkZwAB/gGOv18WEccJ1A7M/0V1BgnHwq0/JmBYSoWEi84XTC+pIyLuszCXPBrPyYY0zPTsv57OBSOxJxoXjXzV3WzJs1D/+X22gy/36m762/vhk8PV5eXOWAm5gZKqDZ5/PCdc2L/vvmjbynGh3fhPus8lVIZFzLI7PBj8BNkOsPMRBc/nURXw+DvIbM7hR3MJnmWdNE6Itt7p2Gr3HAHKblxVcyfsp724x5CnPfizbh36WVDvpaUNIMfhplbb+1Xtp87hhfPr687lq/qB4HD9ec1vN98+OzhQ9Rfp26zKq34BS47ygVtBZdNS3AjMCnb0MU/d0NyH/NEH15WmYu/BZ+7q2L6b1oN9LvVS3se5z+B4w6lWIOSHOl5+rmiSJoOI9b0jZZATMPUD7bsm5ZGjrsKfjfNcb+faPH0LyoNW7KCBgAA" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/communication/data-plane/Chat/preview/2023-11-15-preview/communicationserviceschat.json b/specification/communication/data-plane/Chat/preview/2023-11-15-preview/communicationserviceschat.json index 5c0d3e90cf35..095c2649aa68 100644 --- a/specification/communication/data-plane/Chat/preview/2023-11-15-preview/communicationserviceschat.json +++ b/specification/communication/data-plane/Chat/preview/2023-11-15-preview/communicationserviceschat.json @@ -1378,7 +1378,7 @@ } }, "ChatAttachment": { - "description": "An attachment in a chat message.", + "description": "An attachment in a chat message. Currently only supported in Teams Interop scenarios.", "required": [ "id", "attachmentType" diff --git a/specification/communication/data-plane/Chat/preview/2023-11-15-preview/examples/Messages_ListChatMessagesWithPageSize.json b/specification/communication/data-plane/Chat/preview/2023-11-15-preview/examples/Messages_ListChatMessagesWithPageSize.json index 9e1fcc0cfc4d..012d42ecc588 100644 --- a/specification/communication/data-plane/Chat/preview/2023-11-15-preview/examples/Messages_ListChatMessagesWithPageSize.json +++ b/specification/communication/data-plane/Chat/preview/2023-11-15-preview/examples/Messages_ListChatMessagesWithPageSize.json @@ -2,7 +2,7 @@ "parameters": { "endpoint": "https://contoso.westus.communications.azure.com", "api-version": "2023-11-15-preview", - "chatThreadId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2", + "chatThreadId": "19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2", "maxPageSize": 5 }, "responses": { @@ -11,18 +11,30 @@ "value": [ { "id": "1593107077690", - "type": "text", + "type": "html", "version": "1593107077683", "sequenceId": "5", "content": { - "message": "So where should we get lunch from today?" + "message": "

This place for lunch? 

\r\n

\"image\"

", + "attachments": [ + { + "id": "0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73", + "attachmentType": "image", + "name": "image", + "url": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/original?api-version=2023-07-01-preview", + "previewUrl": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages/1700844519132/teamsInterop/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/small?api-version=2023-07-01-preview" + } + ] }, "senderDisplayName": "Jane", "createdOn": "2020-06-25T17:44:37.6830000Z", + "metadata": { + "amsreferences": "[\"0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73\"]" + }, "senderCommunicationIdentifier": { - "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "rawId": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", "communicationUser": { - "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + "id": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" } } }, @@ -118,7 +130,7 @@ "createdOn": "2020-06-25T17:42:56.7530000Z" } ], - "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2023-11-15-preview" + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2023-11-15-preview" } }, "401": { diff --git a/specification/communication/data-plane/Chat/readme.md b/specification/communication/data-plane/Chat/readme.md index 4c8dd0eb8ff6..535286995392 100644 --- a/specification/communication/data-plane/Chat/readme.md +++ b/specification/communication/data-plane/Chat/readme.md @@ -26,7 +26,7 @@ These are the global settings for the communicationservices. ``` yaml openapi-type: data-plane -tag: package-2023-11-15-preview +tag: package-chat-2023-11-07 ``` @@ -148,6 +148,17 @@ title: Azure Communication Services ``` +### Tag: package-chat-2023-11-07 + +These settings apply only when `--tag=package-2023-11-07` is specified on the command line. + +``` yaml $(tag) == 'package-chat-2023-11-07' +input-file: + - stable/2023-11-07/communicationserviceschat.json +title: + Azure Communication Services +``` + --- # Code Generation diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/communicationserviceschat.json b/specification/communication/data-plane/Chat/stable/2023-11-07/communicationserviceschat.json new file mode 100644 index 000000000000..4a16129a26df --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/communicationserviceschat.json @@ -0,0 +1,1786 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Communication Chat Service", + "description": "Azure Communication Chat Service", + "version": "2023-11-07" + }, + "paths": { + "/chat/threads/{chatThreadId}/readReceipts": { + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets chat message read receipts for a thread.", + "operationId": "ChatThread_ListChatReadReceipts", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to get the chat message read receipts for.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of chat message read receipts to be returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Skips chat message read receipts up to a specified position in response.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns the requested `ChatMessageReadReceipt` resources.", + "schema": { + "$ref": "#/definitions/ChatMessageReadReceiptsCollection" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get thread read receipts with pagination (max page size)": { + "$ref": "./examples/Conversations_ListChatReadReceiptsWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + }, + "post": { + "tags": [ + "Threads" + ], + "summary": "Sends a read receipt event to a thread, on behalf of a user.", + "operationId": "ChatThread_SendChatReadReceipt", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to send the read receipt event to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "sendReadReceiptRequest", + "description": "Read receipt details.", + "required": true, + "schema": { + "$ref": "#/definitions/SendReadReceiptRequest" + } + } + ], + "responses": { + "200": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Send read receipt": { + "$ref": "./examples/Conversations_SendChatReadReceipt.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/messages": { + "post": { + "tags": [ + "Messages" + ], + "summary": "Sends a message to a thread.", + "operationId": "ChatThread_SendChatMessage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to send the message to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "sendChatMessageRequest", + "description": "Details of the message to send.", + "required": true, + "schema": { + "$ref": "#/definitions/SendChatMessageRequest" + } + } + ], + "responses": { + "201": { + "description": "Message sent, the `Location` header contains the URL for the newly sent message.", + "schema": { + "$ref": "#/definitions/SendChatMessageResult" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Send Message": { + "$ref": "./examples/Messages_SendChatMessage.json" + } + } + }, + "get": { + "tags": [ + "Messages" + ], + "summary": "Gets a list of messages from a thread.", + "operationId": "ChatThread_ListChatMessages", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id of the message.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of messages to be returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "startTime", + "description": "The earliest point in time to get messages up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ChatMessagesCollection" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get messages with pagination (max page size)": { + "$ref": "./examples/Messages_ListChatMessagesWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/chat/threads/{chatThreadId}/messages/{chatMessageId}": { + "get": { + "tags": [ + "Messages" + ], + "summary": "Gets a message by id.", + "operationId": "ChatThread_GetChatMessage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a `Message` resource.", + "schema": { + "$ref": "#/definitions/ChatMessage" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Message": { + "$ref": "./examples/Messages_GetChatMessage.json" + } + } + }, + "patch": { + "tags": [ + "Messages" + ], + "summary": "Updates a message.", + "operationId": "ChatThread_UpdateChatMessage", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "updateChatMessageRequest", + "description": "Details of the request to update the message.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateChatMessageRequest" + } + } + ], + "responses": { + "204": { + "description": "Message is successfully updated." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Update message content": { + "$ref": "./examples/Messages_UpdateChatMessage.json" + } + } + }, + "delete": { + "tags": [ + "Messages" + ], + "summary": "Deletes a message.", + "operationId": "ChatThread_DeleteChatMessage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Delete message": { + "$ref": "./examples/Messages_DeleteChatMessage.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/participants": { + "get": { + "tags": [ + "Participants" + ], + "summary": "Gets the participants of a thread.", + "operationId": "ChatThread_ListChatParticipants", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to get participants for.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of participants to be returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "skip", + "description": "Skips participants up to a specified position in response.", + "type": "integer", + "format": "int32" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns the participants of a thread.", + "schema": { + "$ref": "#/definitions/ChatParticipantsCollection" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get participants with pagination (max page size)": { + "$ref": "./examples/Participants_ListChatParticipantsWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/chat/threads/{chatThreadId}/participants/:remove": { + "post": { + "tags": [ + "Participants" + ], + "summary": "Remove a participant from a thread.", + "operationId": "ChatThread_RemoveChatParticipant", + "consumes": [ + "application/json", + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to remove the participant from.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "participantCommunicationIdentifier", + "description": "Id of the thread participant to remove from the thread.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Remove participant": { + "$ref": "./examples/Participants_RemoveChatParticipant.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/participants/:add": { + "post": { + "tags": [ + "Participants" + ], + "summary": "Adds thread participants to a thread. If participants already exist, no change occurs.", + "operationId": "ChatThread_AddChatParticipants", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread to add participants to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "addChatParticipantsRequest", + "description": "Thread participants to be added to the thread.", + "required": true, + "schema": { + "$ref": "#/definitions/AddChatParticipantsRequest" + } + } + ], + "responses": { + "201": { + "description": "The participants were successfully added.", + "schema": { + "$ref": "#/definitions/AddChatParticipantsResult" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Add participants": { + "$ref": "./examples/Participants_AddChatParticipants.json" + } + } + } + }, + "/chat/threads": { + "post": { + "tags": [ + "Threads" + ], + "summary": "Creates a chat thread.", + "operationId": "Chat_CreateChatThread", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "header", + "name": "repeatability-request-id", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.", + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "createChatThreadRequest", + "description": "Request payload for creating a chat thread.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateChatThreadRequest" + } + } + ], + "responses": { + "201": { + "description": "Thread created, the `Location` header would contain the URL for the newly created thread.", + "schema": { + "$ref": "#/definitions/CreateChatThreadResult" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Create chat thread": { + "$ref": "./examples/Threads_CreateChatThread.json" + }, + "Create chat thread with repeatability request id header": { + "$ref": "./examples/Threads_CreateChatThreadWithIdempotencyToken.json" + } + } + }, + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets the list of chat threads of a user.", + "operationId": "Chat_ListChatThreads", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of chat threads returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "startTime", + "description": "The earliest point in time to get chat threads up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a `GetThreadsResponse` resource.", + "schema": { + "$ref": "#/definitions/ChatThreadsItemCollection" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get threads with pagination (Max Page Size)": { + "$ref": "./examples/Threads_ListChatThreadsWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/chat/threads/{chatThreadId}": { + "patch": { + "tags": [ + "Threads" + ], + "summary": "Updates a thread's properties.", + "operationId": "ChatThread_UpdateChatThreadProperties", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The id of the thread to update.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "updateChatThreadRequest", + "description": "Request payload for updating a chat thread.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateChatThreadRequest" + } + } + ], + "responses": { + "204": { + "description": "Thread was successfully updated." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Update chat thread topic": { + "$ref": "./examples/Threads_UpdateChatThreadTopic.json" + } + } + }, + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets a chat thread's properties.", + "operationId": "ChatThread_GetChatThreadProperties", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a chat thread.", + "schema": { + "$ref": "#/definitions/ChatThreadProperties" + } + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get chat thread": { + "$ref": "./examples/Threads_GetChatThread.json" + } + } + }, + "delete": { + "tags": [ + "Threads" + ], + "summary": "Deletes a thread.", + "operationId": "Chat_DeleteChatThread", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread to be deleted.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Delete chat thread": { + "$ref": "./examples/Threads_DeleteChatThread.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/typing": { + "post": { + "tags": [ + "TypingNotifications" + ], + "summary": "Posts a typing event to a thread, on behalf of a user.", + "operationId": "ChatThread_SendTypingNotification", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "sendTypingNotificationRequest", + "description": "Details of the typing notification request.", + "schema": { + "$ref": "#/definitions/SendTypingNotificationRequest" + } + } + ], + "responses": { + "200": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable.", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Post typing event to a thread": { + "$ref": "./examples/Messages_SendTypingNotification.json" + } + } + } + } + }, + "definitions": { + "CommunicationUserIdentifierModel": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationUserIdentifierModel" + }, + "CommunicationCloudEnvironment": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationCloudEnvironmentModel" + }, + "MicrosoftTeamsUserIdentifierModel": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/MicrosoftTeamsUserIdentifierModel" + }, + "CommunicationIdentifierModel": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationIdentifierModel" + }, + "ChatMessageReadReceipt": { + "description": "A chat message read receipt indicates the time a chat message was read by a recipient.", + "required": [ + "chatMessageId", + "readOn", + "senderCommunicationIdentifier" + ], + "type": "object", + "properties": { + "senderCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "chatMessageId": { + "description": "Id of the chat message that has been read. This id is generated by the server.", + "type": "string", + "example": "1591137790240" + }, + "readOn": { + "format": "date-time", + "description": "The time at which the message was read. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatMessageReadReceiptsCollection": { + "description": "A paged collection of chat message read receipts.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of chat message read receipts.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatMessageReadReceipt" + } + }, + "nextLink": { + "description": "If there are more chat message read receipts that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "CommunicationError": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationError" + }, + "CommunicationErrorResponse": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse" + }, + "SendReadReceiptRequest": { + "description": "Request payload for sending a read receipt.", + "required": [ + "chatMessageId" + ], + "type": "object", + "properties": { + "chatMessageId": { + "description": "Id of the latest chat message read by the user.", + "type": "string", + "example": "1592435762364" + } + } + }, + "ChatMessageType": { + "description": "The chat message type.", + "enum": [ + "text", + "html", + "topicUpdated", + "participantAdded", + "participantRemoved" + ], + "type": "string", + "x-ms-enum": { + "name": "ChatMessageType", + "modelAsString": true + } + }, + "SendChatMessageRequest": { + "description": "Details of the message to send.", + "required": [ + "content" + ], + "type": "object", + "properties": { + "content": { + "description": "Chat message content.", + "type": "string", + "example": "Come one guys, lets go for lunch together." + }, + "senderDisplayName": { + "description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.", + "type": "string", + "example": "Bob Admin" + }, + "type": { + "$ref": "#/definitions/ChatMessageType" + }, + "metadata": { + "description": "Message metadata.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SendChatMessageResult": { + "description": "Result of the send message operation.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "A server-generated message id.", + "type": "string", + "example": "123456789" + } + } + }, + "ChatParticipant": { + "description": "A participant of the chat thread.", + "required": [ + "communicationIdentifier" + ], + "type": "object", + "properties": { + "communicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "displayName": { + "description": "Display name for the chat participant.", + "type": "string", + "example": "Bob" + }, + "shareHistoryTime": { + "format": "date-time", + "description": "Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatAttachmentType": { + "description": "The type of attachment.", + "enum": [ + "image" + ], + "type": "string", + "x-ms-enum": { + "name": "ChatAttachmentType", + "modelAsString": true + } + }, + "ChatAttachment": { + "description": "An attachment in a chat message.", + "required": [ + "id", + "attachmentType" + ], + "type": "object", + "properties": { + "id": { + "description": "Id of the attachment", + "type": "string", + "example": "A27C7079-626F-4D23-8BEE-582F2C376B5A" + }, + "attachmentType": { + "$ref": "#/definitions/ChatAttachmentType" + }, + "name": { + "description": "The name of the attachment content.", + "type": "string", + "example": "SomeImage.png" + }, + "url": { + "description": "The URL where the attachment can be downloaded", + "type": "string", + "format": "uri", + "example": "https://{geoChatGW}/threads/{chatThreadId}/images/{imageId}/views/original" + }, + "previewUrl": { + "description": "The URL where the preview of attachment can be downloaded", + "type": "string", + "format": "uri", + "example": "https://{geoChatGW}/threads/{chatThreadId}/images/{imageId}/views/small" + } + } + }, + "ChatMessageContent": { + "description": "Content of a chat message.", + "type": "object", + "properties": { + "message": { + "description": "Chat message content for messages of types text or html.", + "type": "string", + "example": "Come one guys, lets go for lunch together." + }, + "topic": { + "description": "Chat message content for messages of type topicUpdated.", + "type": "string", + "example": "Lunch Chat thread" + }, + "participants": { + "description": "Chat message content for messages of types participantAdded or participantRemoved.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + }, + "attachments": { + "description": "List of attachments for this message", + "type": "array", + "items": { + "$ref": "#/definitions/ChatAttachment" + } + }, + "initiatorCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + } + }, + "ChatMessage": { + "description": "Chat message.", + "required": [ + "createdOn", + "id", + "sequenceId", + "type", + "version" + ], + "type": "object", + "properties": { + "id": { + "description": "The id of the chat message. This id is server generated.", + "type": "string", + "example": "123456789" + }, + "type": { + "$ref": "#/definitions/ChatMessageType" + }, + "sequenceId": { + "description": "Sequence of the chat message in the conversation.", + "type": "string" + }, + "version": { + "description": "Version of the chat message.", + "type": "string" + }, + "content": { + "$ref": "#/definitions/ChatMessageContent" + }, + "senderDisplayName": { + "description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.", + "type": "string", + "example": "Jane" + }, + "createdOn": { + "format": "date-time", + "description": "The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "senderCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "deletedOn": { + "format": "date-time", + "description": "The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "editedOn": { + "format": "date-time", + "description": "The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "metadata": { + "description": "Message metadata.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ChatMessagesCollection": { + "description": "Collection of chat messages for a particular chat thread.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of chat messages.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatMessage" + } + }, + "nextLink": { + "description": "If there are more chat messages that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateChatMessageRequest": { + "description": "Request payload for updating a chat message.", + "type": "object", + "properties": { + "content": { + "description": "Chat message content.", + "type": "string", + "example": "Let's go for lunch together." + }, + "metadata": { + "description": "Message metadata.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ChatParticipantsCollection": { + "description": "Collection of participants belong to a particular thread.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Chat participants.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + }, + "nextLink": { + "description": "If there are more chat participants that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "AddChatParticipantsRequest": { + "description": "Participants to be added to the thread.", + "required": [ + "participants" + ], + "type": "object", + "properties": { + "participants": { + "description": "Participants to add to a chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + } + } + }, + "AddChatParticipantsResult": { + "description": "Result of the add chat participants operation.", + "type": "object", + "properties": { + "invalidParticipants": { + "description": "The participants that failed to be added to the chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationError" + }, + "readOnly": true + } + } + }, + "CreateChatThreadRequest": { + "description": "Request payload for creating a chat thread.", + "required": [ + "topic" + ], + "type": "object", + "properties": { + "topic": { + "description": "The chat thread topic.", + "type": "string", + "example": "Lunch Thread" + }, + "participants": { + "description": "Participants to be added to the chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatParticipant" + } + } + } + }, + "ChatThreadProperties": { + "description": "Chat thread.", + "required": [ + "createdByCommunicationIdentifier", + "createdOn", + "id", + "topic" + ], + "type": "object", + "properties": { + "id": { + "description": "Chat thread id.", + "type": "string", + "example": "19:uni01_uy5ucb66ugp3lrhe7pxso6xx4hsmm3dl6eyjfefv2n6x3rrurpea@thread.v2" + }, + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Chat thread" + }, + "createdOn": { + "format": "date-time", + "description": "The timestamp when the chat thread was created. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "createdByCommunicationIdentifier": { + "$ref": "#/definitions/CommunicationIdentifierModel" + }, + "deletedOn": { + "format": "date-time", + "description": "The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + } + } + }, + "CreateChatThreadResult": { + "description": "Result of the create chat thread operation.", + "type": "object", + "properties": { + "chatThread": { + "$ref": "#/definitions/ChatThreadProperties" + }, + "invalidParticipants": { + "description": "The participants that failed to be added to the chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationError" + }, + "readOnly": true + } + } + }, + "ChatThreadItem": { + "description": "Summary information of a chat thread.", + "required": [ + "id", + "topic" + ], + "type": "object", + "properties": { + "id": { + "description": "Chat thread id.", + "type": "string", + "example": "19:uni01_uy5ucb66ugp3lrhe7pxso6xx4hsmm3dl6eyjfefv2n6x3rrurpea@thread.v2" + }, + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Chat thread" + }, + "deletedOn": { + "format": "date-time", + "description": "The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "lastMessageReceivedOn": { + "format": "date-time", + "description": "The timestamp when the last message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "readOnly": true, + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatThreadsItemCollection": { + "description": "Collection of chat threads.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of chat threads.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatThreadItem" + } + }, + "nextLink": { + "description": "If there are more chat threads that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateChatThreadRequest": { + "description": "Request payload for updating a chat thread.", + "type": "object", + "properties": { + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Thread" + } + } + }, + "SendTypingNotificationRequest": { + "description": "Request payload for typing notifications.", + "type": "object", + "properties": { + "senderDisplayName": { + "description": "The display name of the typing notification sender. This property is used to populate sender name for push notifications.", + "type": "string", + "example": "Bob Admin" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "in": "query", + "name": "api-version", + "description": "Version of API to invoke.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "in": "path", + "name": "endpoint", + "description": "The endpoint of the Azure Communication resource.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "Authorization": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "An ACS (Azure Communication Services) user access token." + } + }, + "security": [ + { + "Authorization": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Conversations_ListChatReadReceiptsWithPageSize.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Conversations_ListChatReadReceiptsWithPageSize.json new file mode 100644 index 000000000000..7c689513fcda --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Conversations_ListChatReadReceiptsWithPageSize.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "maxPageSize": 2 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "chatMessageId": "1591137790240", + "readOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "chatMessageId": "1591768249318", + "readOn": "2020-06-06T05:55:41.6460000Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/readReceipts?skip=2&maxPageSize=2&api-version=2023-11-07" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Conversations_SendChatReadReceipt.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Conversations_SendChatReadReceipt.json new file mode 100644 index 000000000000..369af00b36e1 --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Conversations_SendChatReadReceipt.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "sendReadReceiptRequest": { + "chatMessageId": "1591137790240" + } + }, + "responses": { + "200": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_DeleteChatMessage.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_DeleteChatMessage.json new file mode 100644 index 000000000000..843ab7cf401f --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_DeleteChatMessage.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "chatMessageId": "1591768249318" + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_GetChatMessage.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_GetChatMessage.json new file mode 100644 index 000000000000..de78819fde9d --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_GetChatMessage.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "chatMessageId": "1591768249318" + }, + "responses": { + "200": { + "body": { + "id": "1591768249318", + "sequenceId": "1", + "type": "text", + "version": "1599016601134", + "content": { + "message": "Let's head out for lunch in 15 minutes." + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-10T05:50:49.3180000Z", + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "metadata": { + "someKey1": "someValue1", + "someKey2": "someValue2" + } + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_ListChatMessagesWithPageSize.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_ListChatMessagesWithPageSize.json new file mode 100644 index 000000000000..4c268681388c --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_ListChatMessagesWithPageSize.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2", + "maxPageSize": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "1593107077690", + "type": "text", + "version": "1593107077683", + "sequenceId": "5", + "content": { + "message": "So where should we get lunch from today?" + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:37.6830000Z", + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "id": "1593107077683", + "type": "text", + "sequenceId": "4", + "version": "1593107077683", + "content": { + "message": "Let's use this chat to decide what to get for lunch today." + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:37.6830000Z", + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "id": "1593107046498", + "type": "text", + "sequenceId": "3", + "version": "1593107046498", + "content": { + "message": "Good morning everyone!" + }, + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:06.4980000Z", + "senderCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "id": "1593106976785", + "type": "topicUpdated", + "sequenceId": "2", + "version": "1593106976785", + "content": { + "initiatorCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "topic": "Lunch" + }, + "createdOn": "2020-06-25T17:42:56.7850000Z" + }, + { + "id": "1593106976753", + "type": "participantAdded", + "version": "1593106976753", + "sequenceId": "1", + "content": { + "initiatorCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + } + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce" + } + } + } + ] + }, + "createdOn": "2020-06-25T17:42:56.7530000Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2023-11-07" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_SendChatMessage.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_SendChatMessage.json new file mode 100644 index 000000000000..e8c04f6d202b --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_SendChatMessage.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "sendChatMessageRequest": { + "content": "Let's head out for lunch in 15 minutes.", + "senderDisplayName": "Jane", + "metadata": { + "someKey1": "someValue1", + "someKey2": "someValue2" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1593072104708" + }, + "body": { + "id": "1593072104708" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_SendTypingNotification.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_SendTypingNotification.json new file mode 100644 index 000000000000..02fb8c3532ca --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_SendTypingNotification.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "sendTypingNotificationRequest": { + "senderDisplayName": "Jane" + } + }, + "responses": { + "200": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_UpdateChatMessage.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_UpdateChatMessage.json new file mode 100644 index 000000000000..9650c686a730 --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Messages_UpdateChatMessage.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "content-type": "application/merge-patch+json", + "api-version": "2023-11-07", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "chatMessageId": "1591768249318", + "updateChatMessageRequest": { + "content": "Updated message content", + "metadata": { + "someKey1": "someValue1", + "someKey2": "someValue2" + } + } + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Participants_AddChatParticipants.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Participants_AddChatParticipants.json new file mode 100644 index 000000000000..9db43814326e --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Participants_AddChatParticipants.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "addChatParticipantsRequest": { + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Peter", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce" + } + }, + "displayName": "Rama", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ] + } + }, + "responses": { + "201": { + "body": { + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "code": "404", + "message": "Not found" + } + ] + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Participants_ListChatParticipantsWithPageSize.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Participants_ListChatParticipantsWithPageSize.json new file mode 100644 index 000000000000..c3e9b3a76abb --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Participants_ListChatParticipantsWithPageSize.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "maxPageSize": 2 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Jane", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/participants?skip=2&maxPageSize=2&api-version=2023-11-07" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Participants_RemoveChatParticipant.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Participants_RemoveChatParticipant.json new file mode 100644 index 000000000000..35c0b47f12ef --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Participants_RemoveChatParticipant.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "participantCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_CreateChatThread.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_CreateChatThread.json new file mode 100644 index 000000000000..d96c01648d16 --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_CreateChatThread.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "createChatThreadRequest": { + "topic": "Lunch", + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Jane" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Alex" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a" + } + }, + "displayName": "Bob" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b" + } + }, + "displayName": "Peter" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "body": { + "chatThread": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdByCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + } + }, + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "code": "404", + "message": "Not found" + } + ] + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_CreateChatThreadWithIdempotencyToken.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_CreateChatThreadWithIdempotencyToken.json new file mode 100644 index 000000000000..57a5f53ab97d --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_CreateChatThreadWithIdempotencyToken.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "idempotency-token": "35dd6e71-251b-5e29-8376-ba93d09c3fbf", + "createChatThreadRequest": { + "topic": "Lunch", + "participants": [ + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + }, + "displayName": "Jane" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "displayName": "Alex" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a" + } + }, + "displayName": "Bob" + }, + { + "communicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b" + } + }, + "displayName": "Peter" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "body": { + "chatThread": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdByCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715" + } + } + }, + "invalidParticipants": [ + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a", + "code": "403", + "message": "Permissions check failed" + }, + { + "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b", + "code": "404", + "message": "Not found" + } + ] + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_DeleteChatThread.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_DeleteChatThread.json new file mode 100644 index 000000000000..86240e640f74 --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_DeleteChatThread.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "19:9525281ac1f947fc884bcee1a9f983c2@thread.v2" + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_GetChatThread.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_GetChatThread.json new file mode 100644 index 000000000000..0639af0400dd --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_GetChatThread.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "responses": { + "200": { + "body": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdByCommunicationIdentifier": { + "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "communicationUser": { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + } + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_ListChatThreadsWithPageSize.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_ListChatThreadsWithPageSize.json new file mode 100644 index 000000000000..b078ca8a2d08 --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_ListChatThreadsWithPageSize.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2023-11-07", + "maxPageSize": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Chat with Samantha", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:a0dfe5fc10e04a7f8d8a64d455f4196d@thread.v2", + "topic": "Presentation Brainstorming", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_n242d2bzammtwxiib7pbjtozeevjqzavzn654ku3dajocexfo2na@thread.v2", + "topic": "Chat with Alex", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:0062022a28be4e0983734f7e45cd8566@thread.v2", + "topic": "Lunch", + "deletedOn": "2020-07-07T05:55:41.6460000Z", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpe@thread.v2", + "topic": "Chat with Bob", + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2023-11-07&maxPageSize=5" + } + }, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_UpdateChatThreadTopic.json b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_UpdateChatThreadTopic.json new file mode 100644 index 000000000000..e1530b564e70 --- /dev/null +++ b/specification/communication/data-plane/Chat/stable/2023-11-07/examples/Threads_UpdateChatThreadTopic.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "content-type": "application/merge-patch+json", + "api-version": "2023-11-07", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "updateChatThreadRequest": { + "topic": "Updated Thread Topic" + } + }, + "responses": { + "204": {}, + "401": { + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + } + }, + "403": { + "body": { + "error": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + } + }, + "429": { + "body": { + "error": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + } + }, + "503": { + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } + } +} diff --git a/specification/communication/data-plane/JobRouter/stable/2023-11-01/communicationservicejobrouter.json b/specification/communication/data-plane/JobRouter/stable/2023-11-01/communicationservicejobrouter.json index 88c8692a6c87..5d62f34dc321 100644 --- a/specification/communication/data-plane/JobRouter/stable/2023-11-01/communicationservicejobrouter.json +++ b/specification/communication/data-plane/JobRouter/stable/2023-11-01/communicationservicejobrouter.json @@ -32,18 +32,6 @@ "consumes": [ "application/json" ], - "security": [ - { - "ApiKeyAuth": [] - } - ], - "securityDefinitions": { - "ApiKeyAuth": { - "type": "apiKey", - "name": "api-key", - "in": "header" - } - }, "tags": [], "paths": { "/routing/classificationPolicies": { diff --git a/specification/communitytraining/resource-manager/readme.java.md b/specification/communitytraining/resource-manager/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/communitytraining/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/availabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/availabilitySet.json new file mode 100644 index 000000000000..6923ffeabea7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/availabilitySet.json @@ -0,0 +1,514 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}": { + "put": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_CreateOrUpdate", + "description": "Create or update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "Parameters supplied to the Create Availability Set operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create an availability set.": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Create.json" + } + } + }, + "patch": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Update", + "description": "Update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySetUpdate" + }, + "description": "Parameters supplied to the Update Availability Set operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AvailabilitySet_Update_MaximumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Update_MaximumSet_Gen.json" + }, + "AvailabilitySet_Update_MinimumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Delete", + "description": "Delete an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AvailabilitySet_Delete_MaximumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Delete_MaximumSet_Gen.json" + }, + "AvailabilitySet_Delete_MinimumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Get", + "description": "Retrieves information about an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AvailabilitySet_Get_MaximumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Get_MaximumSet_Gen.json" + }, + "AvailabilitySet_Get_MinimumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List availability sets in a subscription.": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_List", + "description": "Lists all availability sets in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvailabilitySet_List_MaximumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_List_MaximumSet_Gen.json" + }, + "AvailabilitySet_List_MinimumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListAvailableSizes", + "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./computeRPCommon.json#/definitions/VirtualMachineSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "AvailabilitySet_ListAvailableSizes_MaximumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_ListAvailableSizes_MaximumSet_Gen.json" + }, + "AvailabilitySet_ListAvailableSizes_MinimumSet_Gen": { + "$ref": "./examples/availabilitySetExamples/AvailabilitySet_ListAvailableSizes_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AvailabilitySetProperties": { + "properties": { + "platformUpdateDomainCount": { + "type": "integer", + "format": "int32", + "description": "Update Domain count." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "A list of references to all virtual machines in the availability set." + }, + "proximityPlacementGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the availability set should be assigned to. Minimum api-version: 2018-04-01." + }, + "statuses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of a resource." + }, + "AvailabilitySetSkuType": { + "type": "string", + "description": "Specifies the sku of an Availability Set. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.", + "enum": [ + "Classic", + "Aligned" + ], + "x-ms-enum": { + "name": "AvailabilitySetSkuTypes", + "modelAsString": true + } + }, + "AvailabilitySet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to an availability set at creation time. An existing VM cannot be added to an availability set." + }, + "AvailabilitySetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated." + }, + "AvailabilitySetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." + } + }, + "required": [ + "value" + ], + "description": "The List Availability Set operation response." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/capacityReservation.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/capacityReservation.json new file mode 100644 index 000000000000..f2ee3bd4b36a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/capacityReservation.json @@ -0,0 +1,1017 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}": { + "put": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_CreateOrUpdate", + "description": "The operation to create or update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified. Please refer to https://aka.ms/CapacityReservation for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + }, + "description": "Parameters supplied to the Create capacity reservation Group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a capacity reservation group.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_Update", + "description": "The operation to update a capacity reservation group. When updating a capacity reservation group, only tags and sharing profile may be modified.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CapacityReservationGroupUpdate" + }, + "description": "Parameters supplied to the Update capacity reservation Group operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CapacityReservationGroup_Update_MaximumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Update_MaximumSet_Gen.json" + }, + "CapacityReservationGroup_Update_MinimumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_Delete", + "description": "The operation to delete a capacity reservation group. This operation is allowed only if all the associated resources are disassociated from the reservation group and all capacity reservations under the reservation group have also been deleted. Please refer to https://aka.ms/CapacityReservation for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CapacityReservationGroup_Delete_MaximumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Delete_MaximumSet_Gen.json" + }, + "CapacityReservationGroup_Delete_MinimumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_Get", + "description": "The operation that retrieves information about a capacity reservation group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the capacity reservations under the capacity reservation group which is a snapshot of the runtime properties of a capacity reservation that is managed by the platform and can change outside of control plane operations.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "CapacityReservationGroupInstanceViewTypes", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a capacity reservation Group.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups": { + "get": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_ListByResourceGroup", + "description": "Lists all of the capacity reservation groups in the specified resource group. Use the nextLink property in the response to get the next page of capacity reservation groups.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.", + "enum": [ + "virtualMachineScaleSetVMs/$ref", + "virtualMachines/$ref" + ], + "x-ms-enum": { + "name": "ExpandTypesForGetCapacityReservationGroups", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List capacity reservation groups in resource group.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/capacityReservationGroups": { + "get": { + "tags": [ + "CapacityReservationGroups" + ], + "operationId": "CapacityReservationGroups_ListBySubscription", + "description": "Lists all of the capacity reservation groups in the subscription. Use the nextLink property in the response to get the next page of capacity reservation groups.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. Based on the expand param(s) specified we return Virtual Machine or ScaleSet VM Instance or both resource Ids which are associated to capacity reservation group in the response.", + "enum": [ + "virtualMachineScaleSetVMs/$ref", + "virtualMachines/$ref" + ], + "x-ms-enum": { + "name": "ExpandTypesForGetCapacityReservationGroups", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List capacity reservation groups in subscription.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservationGroup_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations/{capacityReservationName}": { + "put": { + "tags": [ + "CapacityReservations" + ], + "operationId": "CapacityReservations_CreateOrUpdate", + "description": "The operation to create or update a capacity reservation. Please note some properties can be set only during capacity reservation creation. Please refer to https://aka.ms/CapacityReservation for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "capacityReservationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CapacityReservation" + }, + "description": "Parameters supplied to the Create capacity reservation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CapacityReservation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a capacity reservation .": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "CapacityReservations" + ], + "operationId": "CapacityReservations_Update", + "description": "The operation to update a capacity reservation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "capacityReservationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CapacityReservationUpdate" + }, + "description": "Parameters supplied to the Update capacity reservation operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservation" + } + }, + "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-examples": { + "CapacityReservation_Update_MaximumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_Update_MaximumSet_Gen.json" + }, + "CapacityReservation_Update_MinimumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "CapacityReservations" + ], + "operationId": "CapacityReservations_Delete", + "description": "The operation to delete a capacity reservation. This operation is allowed only when all the associated resources are disassociated from the capacity reservation. Please refer to https://aka.ms/CapacityReservation for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "capacityReservationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CapacityReservation_Delete_MaximumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_Delete_MaximumSet_Gen.json" + }, + "CapacityReservation_Delete_MinimumSet_Gen": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "CapacityReservations" + ], + "operationId": "CapacityReservations_Get", + "description": "The operation that retrieves information about the capacity reservation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "name": "capacityReservationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "CapacityReservationInstanceViewTypes", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a capacity reservation.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/capacityReservations": { + "get": { + "tags": [ + "CapacityReservation" + ], + "operationId": "CapacityReservations_ListByCapacityReservationGroup", + "description": "Lists all of the capacity reservations in the specified capacity reservation group. Use the nextLink property in the response to get the next page of capacity reservations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "capacityReservationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the capacity reservation group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapacityReservationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List capacity reservations in reservation group.": { + "$ref": "./examples/capacityReservationExamples/CapacityReservation_ListByReservationGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "CapacityReservationGroupInstanceView": { + "type": "object", + "properties": { + "capacityReservations": { + "type": "array", + "items": { + "$ref": "#/definitions/CapacityReservationInstanceViewWithName" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true, + "description": "List of instance view of the capacity reservations under the capacity reservation group." + }, + "sharedSubscriptionIds": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "x-ms-identifiers": [ + "id" + ], + "readOnly": true, + "description": "List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details." + } + } + }, + "ResourceSharingProfile": { + "type": "object", + "properties": { + "subscriptionIds": { + "type": "array", + "description": "Specifies an array of subscription resource IDs that capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + } + } + }, + "CapacityReservationGroupProperties": { + "type": "object", + "properties": { + "capacityReservations": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of all capacity reservation resource ids that belong to capacity reservation group." + }, + "virtualMachinesAssociated": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all virtual machines associated to the capacity reservation group." + }, + "instanceView": { + "$ref": "#/definitions/CapacityReservationGroupInstanceView", + "readOnly": true, + "description": "The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group." + }, + "sharingProfile": { + "$ref": "#/definitions/ResourceSharingProfile", + "description": "Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details." + } + }, + "description": "capacity reservation group Properties." + }, + "CapacityReservationGroup": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CapacityReservationGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the capacity reservation group that the capacity reservations should be assigned to. Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group." + }, + "CapacityReservationGroupUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CapacityReservationGroupProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the capacity reservation group. Only tags can be updated." + }, + "CapacityReservationGroupListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CapacityReservationGroup" + }, + "description": "The list of capacity reservation groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capacity reservation groups. Call ListNext() with this URI to fetch the next page of capacity reservation groups." + } + }, + "required": [ + "value" + ], + "description": "The List capacity reservation group with resource group response." + }, + "CapacityReservationInstanceView": { + "type": "object", + "properties": { + "utilizationInfo": { + "$ref": "#/definitions/CapacityReservationUtilization", + "description": "Unutilized capacity of the capacity reservation." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations." + }, + "CapacityReservationUtilization": { + "type": "object", + "properties": { + "currentCapacity": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01." + }, + "virtualMachinesAllocated": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of all virtual machines resource ids allocated against the capacity reservation." + } + }, + "description": "Represents the capacity reservation utilization in terms of resources allocated." + }, + "CapacityReservationInstanceViewWithName": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the capacity reservation." + } + }, + "allOf": [ + { + "$ref": "#/definitions/CapacityReservationInstanceView" + } + ], + "description": "The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group." + }, + "CapacityReservationProperties": { + "type": "object", + "properties": { + "reservationId": { + "readOnly": true, + "type": "string", + "description": "A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource." + }, + "platformFaultDomainCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01." + }, + "virtualMachinesAssociated": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of all virtual machine resource ids that are associated with the capacity reservation." + }, + "provisioningTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date time when the capacity reservation was last updated." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/CapacityReservationInstanceView", + "readOnly": true, + "description": "The Capacity reservation instance view." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01." + } + }, + "description": "Properties of the Capacity reservation." + }, + "CapacityReservation": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CapacityReservationProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "required": [ + "sku" + ], + "description": "Specifies information about the capacity reservation." + }, + "CapacityReservationUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CapacityReservationProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values." + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the capacity reservation. Only tags and sku.capacity can be updated." + }, + "CapacityReservationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CapacityReservation" + }, + "description": "The list of capacity reservations" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capacity reservations. Call ListNext() with this URI to fetch the next page of capacity reservations." + } + }, + "required": [ + "value" + ], + "description": "The list capacity reservation operation response." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/computeRPCommon.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/computeRPCommon.json new file mode 100644 index 000000000000..d090e37bf1bb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/computeRPCommon.json @@ -0,0 +1,2027 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Compute/operations": { + "get": { + "tags": [ + "ComputeOperations" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComputeOperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/Operations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usage_List_MaximumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json" + }, + "Usage_List_MinimumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "This API is deprecated. Use [Resources Skus](https://docs.microsoft.com/rest/api/compute/resourceskus/list)", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "VirtualMachineSizes_List_MaximumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/VirtualMachineSizes_List_MaximumSet_Gen.json" + }, + "VirtualMachineSizes_List_MinimumSet_Gen": { + "$ref": "./examples/computeRPCommonExamples/VirtualMachineSizes_List_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "ComputeOperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ComputeOperationValue" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "ComputeOperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ComputeOperationValueDisplay" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "ComputeOperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute 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 Compute Operation Value Display." + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [], + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + }, + "required": [ + "value" + ], + "description": "The List Usages operation response." + }, + "HyperVGenerationType": { + "type": "string", + "description": "Specifies the HyperVGeneration Type", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationTypes", + "modelAsString": true + } + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "type": "object", + "description": "Instance view status." + }, + "SubResourceWithColocationStatus": { + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "properties": { + "colocationStatus": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "Describes colocation status of a resource in the Proximity Placement Group." + } + }, + "x-ms-azure-resource": true + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual machine size." + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "The number of cores supported by the virtual machine size. For Constrained vCPU capable VM sizes, this number represents the total vCPUs of quota that the VM uses. For accurate vCPU count, please refer to https://docs.microsoft.com/azure/virtual-machines/constrained-vcpu or https://docs.microsoft.com/rest/api/compute/resourceskus/list" + }, + "osDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The OS disk size, in MB, allowed by the virtual machine size." + }, + "resourceDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The resource disk size, in MB, allowed by the virtual machine size." + }, + "memoryInMB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory, in MB, supported by the virtual machine size." + }, + "maxDataDiskCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of data disks that can be attached to the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of virtual machine sizes." + } + }, + "description": "The List Virtual Machine operation response." + }, + "Plan": { + "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 promotion code." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set.", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_B1s", + "Standard_B1ms", + "Standard_B2s", + "Standard_B2ms", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_DS13-4_v2", + "Standard_DS13-2_v2", + "Standard_DS14-8_v2", + "Standard_DS14-4_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_E32-16_v3", + "Standard_E32-8s_v3", + "Standard_E64-32s_v3", + "Standard_E64-16s_v3", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_GS4-8", + "Standard_GS4-4", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_M64-32ms", + "Standard_M64-16ms", + "Standard_M128-64ms", + "Standard_M128-32ms", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC6s_v2", + "Standard_NC12s_v2", + "Standard_NC24s_v2", + "Standard_NC24rs_v2", + "Standard_NC6s_v3", + "Standard_NC12s_v3", + "Standard_NC24s_v3", + "Standard_NC24rs_v3", + "Standard_ND6s", + "Standard_ND12s", + "Standard_ND24s", + "Standard_ND24rs", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ], + "x-ms-enum": { + "name": "VirtualMachineSizeTypes", + "modelAsString": true + } + }, + "vmSizeProperties": { + "$ref": "#/definitions/VMSizeProperties", + "description": "Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details." + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "VMSizeProperties": { + "type": "object", + "properties": { + "vCPUsAvailable": { + "type": "integer", + "format": "int32", + "description": "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)." + }, + "vCPUsPerCore": { + "type": "integer", + "format": "int32", + "description": "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.**" + } + }, + "description": "Specifies VM Size Property settings on the virtual machine." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the 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 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." + }, + "exactVersion": { + "type": "string", + "readOnly": true, + "description": "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'." + }, + "sharedGalleryImageId": { + "type": "string", + "description": "Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call." + }, + "communityGalleryImageId": { + "type": "string", + "description": "Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "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." + }, + "DiskControllerType": { + "type": "string", + "enum": [ + "SCSI", + "NVMe" + ], + "x-ms-enum": { + "name": "DiskControllerTypes", + "modelAsString": true + }, + "description": "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." + }, + "KeyVaultSecretReference": { + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "DiskEncryptionSetParameters": { + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "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.", + "x-ms-azure-resource": true + }, + "KeyVaultKeyReference": { + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the key." + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "DiskEncryptionSettings": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the key encryption key in Key Vault." + }, + "enabled": { + "type": "boolean", + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "VMDiskSecurityProfile": { + "type": "object", + "properties": { + "securityEncryptionType": { + "type": "string", + "description": "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.", + "enum": [ + "VMGuestStateOnly", + "DiskWithVMGuestState", + "NonPersistedTPM" + ], + "x-ms-enum": { + "name": "securityEncryptionTypes", + "modelAsString": true + } + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "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." + } + }, + "description": "Specifies the security profile settings for the managed disk. **Note:** It can only be set for Confidential VMs." + }, + "VirtualHardDisk": { + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "Caching": { + "type": "string", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "CreateOption": { + "type": "string", + "description": "Specifies how the virtual machine should be created. Possible values are: **Attach.** This value is used when you are using a specialized disk to create the virtual machine. **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.", + "enum": [ + "FromImage", + "Empty", + "Attach" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true + } + }, + "DetachOption": { + "type": "string", + "description": "Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values are: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. **This feature is still in preview** mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.", + "enum": [ + "ForceDetach" + ], + "x-ms-enum": { + "name": "DiskDetachOptionTypes", + "modelAsString": true + } + }, + "DeleteOption": { + "type": "string", + "description": "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.", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DiskDeleteOptionTypes", + "modelAsString": true + } + }, + "StorageAccountType": { + "type": "string", + "description": "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", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true + } + }, + "DiffDiskOption": { + "type": "string", + "description": "Specifies the ephemeral disk option for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOptions", + "modelAsString": true + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "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", + "enum": [ + "CacheDisk", + "ResourceDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": true + } + }, + "DiffDiskSettings": { + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOption", + "description": "Specifies the ephemeral disk settings for operating system disk." + }, + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "description": "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." + } + }, + "description": "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." + }, + "ManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "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." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk." + }, + "securityProfile": { + "$ref": "#/definitions/VMDiskSecurityProfile", + "description": "Specifies the security profile for the managed disk." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "The parameters of a managed disk." + }, + "OSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "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.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "encryptionSettings": { + "$ref": "#/definitions/DiskEncryptionSettings", + "description": "Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created. Possible values are: **Attach.** This value is used when you are using a specialized disk to create the virtual machine. **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "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." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOption", + "description": "Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk." + } + }, + "required": [ + "createOption" + ], + "description": "Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created. Possible values are: **Attach.** This value is used when you are using a specialized disk to create the virtual machine. **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "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." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + }, + "toBeDetached": { + "type": "boolean", + "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" + }, + "diskIOPSReadWrite": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set." + }, + "diskMBpsReadWrite": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set." + }, + "detachOption": { + "$ref": "#/definitions/DetachOption", + "description": "Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. **This feature is still in preview** mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'." + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOption", + "description": "Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**." + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a data disk." + }, + "CapacityReservationProfile": { + "type": "object", + "properties": { + "capacityReservationGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "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." + } + }, + "description": "The parameters of a capacity reservation Profile." + }, + "StorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "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." + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "diskControllerType": { + "$ref": "#/definitions/DiskControllerType", + "description": "Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "UefiSettings": { + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01." + } + }, + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01." + }, + "EncryptionIdentity": { + "type": "object", + "properties": { + "userAssignedIdentityResourceId": { + "type": "string", + "description": "Specifies ARM Resource ID of one of the user identities associated with the VM." + } + }, + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault operations." + }, + "ProxyAgentSettings": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set." + }, + "mode": { + "type": "string", + "description": "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.", + "enum": [ + "Audit", + "Enforce" + ], + "x-ms-enum": { + "name": "Mode", + "modelAsString": true + } + }, + "keyIncarnationId": { + "type": "integer", + "format": "int32", + "description": "Increase the value of this property allows user to reset the key used for securing communication channel between guest and host." + } + }, + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01." + }, + "SecurityProfile": { + "properties": { + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "description": "Specifies the security settings like secure boot and vTPM used while creating the 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 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." + }, + "securityType": { + "type": "string", + "description": "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.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true + } + }, + "encryptionIdentity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault operations." + }, + "proxyAgentSettings": { + "$ref": "#/definitions/ProxyAgentSettings", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01." + } + }, + "description": "Specifies the Security profile settings for the virtual machine or virtual machine scale set." + }, + "VMGalleryApplication": { + "type": "object", + "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", + "description": "Specifies the GalleryApplicationVersion resource id on the form of /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 configuration for the package if provided" + }, + "treatFailureAsDeploymentFailure": { + "type": "boolean", + "description": "Optional, If true, any failure for any operation in the VmApplication will fail the deployment" + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS" + } + }, + "required": [ + "packageReferenceId" + ], + "description": "Specifies the required information to reference a compute gallery application version" + }, + "ApplicationProfile": { + "type": "object", + "properties": { + "galleryApplications": { + "type": "array", + "items": { + "$ref": "#/definitions/VMGalleryApplication" + }, + "x-ms-identifiers": [ + "packageReferenceId" + ], + "description": "Specifies the gallery applications that should be made available to the VM/VMSS" + } + }, + "description": "Contains the list of gallery applications that should be made available to the VM/VMSS" + }, + "AdditionalCapabilities": { + "properties": { + "ultraSSDEnabled": { + "type": "boolean", + "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled." + }, + "hibernationEnabled": { + "type": "boolean", + "description": "The flag that enables or disables hibernation capability on the VM." + } + }, + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "AdditionalUnattendContent": { + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "name": "PassNames", + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "name": "ComponentNames", + "modelAsString": false + } + }, + "settingName": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": false + } + }, + "content": { + "type": "string", + "description": "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." + } + }, + "description": "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." + }, + "WinRMListener": { + "properties": { + "protocol": { + "type": "string", + "description": "Specifies the protocol of WinRM listener. Possible values are: **http,** **https.**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": false + } + }, + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be 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)." + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + }, + "WinRMConfiguration": { + "properties": { + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "x-ms-identifiers": [], + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WindowsConfiguration": { + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "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." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "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." + }, + "timeZone": { + "type": "string", + "description": "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)." + }, + "additionalUnattendContent": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "x-ms-identifiers": [], + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "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 PowerShell." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false." + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "SshPublicKey": { + "properties": { + "path": { + "type": "string", + "description": "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" + }, + "keyData": { + "type": "string", + "description": "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)." + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "SshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "path" + ], + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "LinuxConfiguration": { + "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 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." + }, + "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 machine. Default value is false." + } + }, + "description": "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)." + }, + "VaultCertificate": { + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}
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)." + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "properties": { + "sourceVault": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "x-ms-identifiers": [ + "certificateUrl" + ], + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules)." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**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." + }, + "adminPassword": { + "type": "string", + "description": "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)", + "x-ms-secret": true + }, + "customData": { + "type": "string", + "description": "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. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)." + }, + "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 list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ], + "description": "Specifies set of certificates that should be installed onto the virtual machine. 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)." + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Optional property which must either be set to True or omitted." + } + }, + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "NetworkInterfaceReferenceProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "deleteOption": { + "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 + } + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkInterfaceReference": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "Describes a network interface reference.", + "x-ms-azure-resource": true + }, + "PublicIPAddressSku": { + "properties": { + "name": { + "type": "string", + "description": "Specify public IP sku name", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Specify public IP sku tier", + "enum": [ + "Regional", + "Global" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuTier", + "modelAsString": true + } + } + }, + "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible." + }, + "NetworkProfile": { + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + }, + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + }, + "networkApiVersion": { + "type": "string", + "description": "specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations", + "enum": [ + "2020-11-01" + ], + "x-ms-enum": { + "name": "NetworkApiVersion", + "modelAsString": true + } + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineNetworkInterfaceConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies the networking configurations that will be used to create the virtual machine networking resources." + } + }, + "description": "Specifies the network interfaces or the networking configuration of the virtual machine." + }, + "BootDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DiagnosticsProfile": { + "properties": { + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "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." + } + }, + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15." + }, + "priority": { + "type": "string", + "description": "Specifies the priority for a standalone virtual machine or the virtual machines in the scale set. 'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS.", + "enum": [ + "Regular", + "Low", + "Spot" + ], + "x-ms-enum": { + "name": "VirtualMachinePriorityTypes", + "modelAsString": true + } + }, + "evictionPolicy": { + "type": "string", + "description": "Specifies the eviction policy for the Azure Spot VM/VMSS", + "enum": [ + "Deallocate", + "Delete" + ], + "x-ms-enum": { + "name": "VirtualMachineEvictionPolicyTypes", + "modelAsString": true + } + }, + "BillingProfile": { + "properties": { + "maxPrice": { + "type": "number", + "format": "double", + "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01." + } + }, + "description": "Specifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-03-01." + }, + "DiskInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + "x-ms-identifiers": [ + "diskEncryptionKey/sourceVault/id" + ], + "description": "Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of the disk." + }, + "BootDiagnosticsInstanceView": { + "properties": { + "consoleScreenshotBlobUri": { + "readOnly": true, + "type": "string", + "description": "The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage." + }, + "serialConsoleLogBlobUri": { + "readOnly": true, + "type": "string", + "description": "The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics." + } + }, + "description": "The instance view of a virtual machine boot diagnostics." + }, + "MaintenanceRedeployStatus": { + "properties": { + "isCustomerInitiatedMaintenanceAllowed": { + "type": "boolean", + "description": "True, if customer is allowed to perform Maintenance." + }, + "preMaintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Pre Maintenance Window." + }, + "preMaintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Pre Maintenance Window." + }, + "maintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Maintenance Window." + }, + "maintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Maintenance Window." + }, + "lastOperationResultCode": { + "type": "string", + "description": "The Last Maintenance Operation Result Code.", + "enum": [ + "None", + "RetryLater", + "MaintenanceAborted", + "MaintenanceCompleted" + ], + "x-ms-enum": { + "name": "MaintenanceOperationResultCodeTypes", + "modelAsString": false + } + }, + "lastOperationMessage": { + "type": "string", + "description": "Message returned for the last Maintenance Operation." + } + }, + "description": "Maintenance Operation Status." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic**" + }, + "capacity": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "ApiEntityReference": { + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "RollbackStatusInfo": { + "properties": { + "successfullyRolledbackInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which have been successfully rolled back." + }, + "failedRolledbackInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which failed to rollback." + }, + "rollbackError": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "Error details if OS rollback failed." + } + }, + "description": "Information about rollback on failed VM instances after a OS Upgrade operation." + }, + "ScheduledEventsProfile": { + "type": "object", + "properties": { + "terminateNotificationProfile": { + "$ref": "#/definitions/TerminateNotificationProfile", + "description": "Specifies Terminate Scheduled Event related configurations." + }, + "osImageNotificationProfile": { + "$ref": "#/definitions/OSImageNotificationProfile", + "description": "Specifies OS Image Scheduled Event related configurations." + } + } + }, + "TerminateNotificationProfile": { + "type": "object", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "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)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + } + } + }, + "OSImageNotificationProfile": { + "type": "object", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "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 be 15 minutes (PT15M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the OS Image Scheduled event is enabled or disabled." + } + } + }, + "ProxyResource": { + "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" + } + }, + "description": "The resource model definition for an Azure Resource Manager proxy resource. It will not have tags and a location", + "x-ms-azure-resource": true + }, + "UpdateResource": { + "type": "object", + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + }, + "PatchSettings": { + "properties": { + "patchMode": { + "type": "string", + "description": "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 ", + "enum": [ + "Manual", + "AutomaticByOS", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchMode", + "modelAsString": true + } + }, + "enableHotpatching": { + "type": "boolean", + "description": "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'." + }, + "assessmentMode": { + "type": "string", + "description": "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. ", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsPatchAssessmentMode", + "modelAsString": true + } + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows." + } + }, + "description": "Specifies settings related to VM Guest Patching on Windows." + }, + "LinuxPatchSettings": { + "properties": { + "patchMode": { + "type": "string", + "description": "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", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchMode", + "modelAsString": true + } + }, + "assessmentMode": { + "type": "string", + "description": "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.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "LinuxPatchAssessmentMode", + "modelAsString": true + } + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux." + } + }, + "description": "Specifies settings related to VM Guest Patching on Linux." + }, + "WindowsVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "properties": { + "rebootSetting": { + "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 + } + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + }, + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings." + }, + "LinuxVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "properties": { + "rebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true + } + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + }, + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings." + }, + "AttachDetachDataDisksRequest": { + "type": "object", + "properties": { + "dataDisksToAttach": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/DataDisksToAttach" + }, + "x-ms-identifiers": [ + "diskId" + ], + "description": "The list of managed data disks to be attached." + }, + "dataDisksToDetach": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/DataDisksToDetach" + }, + "x-ms-identifiers": [ + "diskId" + ], + "description": "The list of managed data disks to be detached." + } + }, + "description": "Specifies the input for attaching and detaching a list of managed data disks." + }, + "DataDisksToAttach": { + "type": "object", + "properties": { + "diskId": { + "type": "string", + "description": "ID of the managed data disk." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "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. If not specified, lun would be auto assigned." + } + }, + "required": [ + "diskId" + ], + "description": "Describes the data disk to be attached." + }, + "DataDisksToDetach": { + "type": "object", + "properties": { + "diskId": { + "type": "string", + "description": "ID of the managed data disk." + }, + "detachOption": { + "$ref": "#/definitions/DetachOption", + "description": "Supported options available for Detach of a disk from a VM. Refer to DetachOption object reference for more details." + } + }, + "required": [ + "diskId" + ], + "description": "Describes the data disk to be detached." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/dedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/dedicatedHost.json new file mode 100644 index 000000000000..c543ec2bb8d2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/dedicatedHost.json @@ -0,0 +1,1209 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}": { + "put": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_CreateOrUpdate", + "description": "Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "Parameters supplied to the Create Dedicated Host Group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host group.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json" + }, + "Create or update a dedicated host group with Ultra SSD support.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json" + } + } + }, + "patch": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Update", + "description": "Update an dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroupUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host Group operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DedicatedHostGroup_Update_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Update_MaximumSet_Gen.json" + }, + "DedicatedHostGroup_Update_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Delete", + "description": "Delete a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DedicatedHostGroup_Delete_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MaximumSet_Gen.json" + }, + "DedicatedHostGroup_Delete_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Get", + "description": "Retrieves information about a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated hosts under the dedicated host group. 'UserData' is not supported for dedicated host group.", + "enum": [ + "instanceView", + "userData" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a dedicated host group.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Get.json" + }, + "Create an ultraSSDEnabled dedicated host group.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_Get_UltraSSDEnabledDedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListByResourceGroup", + "description": "Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.json" + }, + "DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListBySubscription", + "description": "Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DedicatedHostGroup_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MaximumSet_Gen.json" + }, + "DedicatedHostGroup_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}": { + "put": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_CreateOrUpdate", + "description": "Create or update a dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "Parameters supplied to the Create Dedicated Host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host .": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Update", + "description": "Update a dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DedicatedHost_Update_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Update_MaximumSet_Gen.json" + }, + "DedicatedHost_Update_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Update_MinimumSet_Gen.json" + }, + "DedicatedHost_Update_Resize": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Update_Resize.json" + } + } + }, + "delete": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Delete", + "description": "Delete a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DedicatedHost_Delete_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Delete_MaximumSet_Gen.json" + }, + "DedicatedHost_Delete_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Get", + "description": "Retrieves information about a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the list of instance views of the dedicated host. 'UserData' is not supported for dedicated host.", + "enum": [ + "instanceView", + "userData" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a dedicated host.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts": { + "get": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_ListByHostGroup", + "description": "Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DedicatedHost_ListByHostGroup_MaximumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json" + }, + "DedicatedHost_ListByHostGroup_MinimumSet_Gen": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/restart": { + "post": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_Restart", + "description": "Restart the dedicated host. The operation will complete successfully once the dedicated host has restarted and is running. To determine the health of VMs deployed on the dedicated host after the restart check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Restart Dedicated Host.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/redeploy": { + "post": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_Redeploy", + "description": "Redeploy the dedicated host. The operation will complete successfully once the dedicated host has migrated to a new node and is running. To determine the health of VMs deployed on the dedicated host after the redeploy check the Resource Health Center in the Azure Portal. Please refer to https://docs.microsoft.com/azure/service-health/resource-health-overview for more details.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "description": "The name of the dedicated host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Redeploy Dedicated Host.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_Redeploy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}/hostSizes": { + "get": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_ListAvailableSizes", + "description": "Lists all available dedicated host sizes to which the specified dedicated host can be resized. NOTE: The dedicated host sizes provided can be used to only scale up the existing dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "description": "The name of the dedicated host." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Get Available Dedicated Host Sizes.": { + "$ref": "./examples/dedicatedHostExamples/DedicatedHost_ListAvailableSizes.json" + } + } + } + } + }, + "definitions": { + "DedicatedHostGroupInstanceView": { + "properties": { + "hosts": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostInstanceViewWithName" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of instance view of the dedicated hosts under the dedicated host group." + } + } + }, + "DedicatedHostGroupProperties": { + "properties": { + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "Number of fault domains that the host group can span." + }, + "hosts": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all dedicated hosts in the dedicated host group." + }, + "instanceView": { + "$ref": "#/definitions/DedicatedHostGroupInstanceView", + "readOnly": true, + "description": "The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group." + }, + "supportAutomaticPlacement": { + "type": "boolean", + "description": "Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'false' when not provided. Minimum api-version: 2020-06-01." + }, + "additionalCapabilities": { + "type": "object", + "properties": { + "ultraSSDEnabled": { + "type": "boolean", + "description": "The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01." + } + }, + "description": "Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01." + } + }, + "required": [ + "platformFaultDomainCount" + ], + "description": "Dedicated Host Group Properties." + }, + "DedicatedHostGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group." + }, + "DedicatedHostGroupUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated." + }, + "DedicatedHostGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "The list of dedicated host groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups." + } + }, + "required": [ + "value" + ], + "description": "The List Dedicated Host Group with resource group response." + }, + "DedicatedHostLicenseType": { + "type": "string", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.**", + "enum": [ + "None", + "Windows_Server_Hybrid", + "Windows_Server_Perpetual" + ], + "x-ms-enum": { + "name": "DedicatedHostLicenseTypes", + "modelAsString": false + } + }, + "DedicatedHostAllocatableVM": { + "properties": { + "vmSize": { + "type": "string", + "description": "VM size in terms of which the unutilized capacity is represented." + }, + "count": { + "type": "number", + "format": "double", + "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity." + } + }, + "description": "Represents the dedicated host unutilized capacity in terms of a specific VM size." + }, + "DedicatedHostAvailableCapacity": { + "properties": { + "allocatableVMs": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostAllocatableVM" + }, + "x-ms-identifiers": [], + "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host." + } + }, + "description": "Dedicated host unutilized capacity." + }, + "DedicatedHostInstanceView": { + "properties": { + "assetId": { + "readOnly": true, + "type": "string", + "description": "Specifies the unique id of the dedicated physical machine on which the dedicated host resides." + }, + "availableCapacity": { + "$ref": "#/definitions/DedicatedHostAvailableCapacity", + "description": "Unutilized capacity of the dedicated host." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of a dedicated host." + }, + "DedicatedHostInstanceViewWithName": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the dedicated host." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DedicatedHostInstanceView" + } + ], + "description": "The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group." + }, + "DedicatedHostProperties": { + "properties": { + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Fault domain of the dedicated host within a dedicated host group." + }, + "autoReplaceOnFailure": { + "type": "boolean", + "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided." + }, + "hostId": { + "readOnly": true, + "type": "string", + "description": "A unique id generated and assigned to the dedicated host by the platform. Does not change throughout the lifetime of the host." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all virtual machines in the Dedicated Host." + }, + "licenseType": { + "$ref": "#/definitions/DedicatedHostLicenseType", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: **None,** **Windows_Server_Hybrid,** **Windows_Server_Perpetual.** The default value is: **None.**" + }, + "provisioningTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date when the host was first provisioned." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/DedicatedHostInstanceView", + "readOnly": true, + "description": "The dedicated host instance view." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Dedicated Host resource was created. Minimum api-version: 2021-11-01." + } + }, + "description": "Properties of the dedicated host." + }, + "DedicatedHost": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "required": [ + "sku" + ], + "description": "Specifies information about the Dedicated host." + }, + "DedicatedHostUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "[List all available dedicated host sizes for resizing] (https://docs.microsoft.com/rest/api/compute/dedicated-hosts/listavailablesizes). Resizing can be only used to scale up DedicatedHost. Only name is required to be set. " + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated." + }, + "DedicatedHostListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "The list of dedicated hosts" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts." + } + }, + "required": [ + "value" + ], + "description": "The list dedicated host operation response." + }, + "DedicatedHostSizeListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of dedicated host sizes." + } + }, + "description": "The List Dedicated Host sizes operation response." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Create.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Create.json new file mode 100644 index 000000000000..cec295d180b1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "availabilitySetName": "myAvailabilitySet", + "parameters": { + "location": "westus", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Classic" + }, + "name": "myAvailabilitySet", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + }, + "location": "westus", + "type": "Microsoft.Compute/availabilitySets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..956dce10a27e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Delete_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "availabilitySetName": "aaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..75808a1d06c4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Delete_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "availabilitySetName": "aaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b4c58b45c12a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Get_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "availabilitySetName": "aaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + }, + "sku": { + "name": "Classic", + "tier": "aaaaaaaaaaaaaa", + "capacity": 29 + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet", + "name": "myAvailabilitySet", + "type": "Microsoft.Compute/availabilitySets", + "tags": { + "key9626": "aaaaaaaaaaaaaaaaaaaa", + "key2505": "aa" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..2cc911cf32a0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Get_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "availabilitySetName": "aaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_ListAvailableSizes_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_ListAvailableSizes_MaximumSet_Gen.json new file mode 100644 index 000000000000..1010a8b484fb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_ListAvailableSizes_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "availabilitySetName": "aaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_A1_V2", + "numberOfCores": 1, + "osDiskSizeInMB": 1047552, + "resourceDiskSizeInMB": 10240, + "memoryInMB": 2048, + "maxDataDiskCount": 2 + }, + { + "name": "Standard_A2_V2", + "numberOfCores": 2, + "osDiskSizeInMB": 1047552, + "resourceDiskSizeInMB": 20480, + "memoryInMB": 4096, + "maxDataDiskCount": 4 + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_ListAvailableSizes_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_ListAvailableSizes_MinimumSet_Gen.json new file mode 100644 index 000000000000..8d2dbd513126 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_ListAvailableSizes_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "availabilitySetName": "aa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_ListBySubscription.json new file mode 100644 index 000000000000..57f951dc7b81 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_ListBySubscription.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "api-version": "2023-09-01", + "$expand": "virtualMachines\\$ref" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] + }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] + }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": { + "{tagName}": "{tagValue}" + }, + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] + }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": { + "{tagName}": "{tagValue}" + }, + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] + }, + "sku": { + "name": "Classic" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..61a12c9669f2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_List_MaximumSet_Gen.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ], + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaa", + "message": "aaaaaa", + "time": "2021-11-30T13:39:56.427Z" + } + ] + }, + "sku": { + "name": "Classic", + "tier": "aaaaaaaaaaaaaaaaaaaaaaa", + "capacity": 22 + }, + "tags": { + "key2039": "aaaaaaaaaaaaa" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ], + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaa", + "message": "aaaaaa", + "time": "2021-11-30T13:39:56.427Z" + } + ] + }, + "sku": { + "name": "Classic", + "tier": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "capacity": 23 + }, + "tags": { + "key5849": "aaaaaaaaaaaaaaa" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": {}, + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [], + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaa", + "message": "aaaaaa", + "time": "2021-11-30T13:39:56.427Z" + } + ] + }, + "sku": { + "name": "Classic", + "tier": "aaaaaaaaaaaaaaaaaaaaa", + "capacity": 26 + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": {}, + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [], + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaa", + "message": "aaaaaa", + "time": "2021-11-30T13:39:56.427Z" + } + ] + }, + "sku": { + "name": "Classic", + "tier": "aaaaaaaaaaaaaaaaaa", + "capacity": 6 + } + } + ], + "nextLink": "aaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..4ad1a151e9d5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_List_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "australiasoutheast", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet1" + }, + { + "location": "australiasoutheast", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet2" + }, + { + "location": "westcentralus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet3" + }, + { + "location": "westcentralus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet4" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..10d338006059 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Update_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "availabilitySetName": "aaaaaaaaaaaaaaaaaaa", + "parameters": { + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "sku": { + "name": "DSv3-Type1", + "tier": "aaa", + "capacity": 7 + }, + "tags": { + "key2574": "aaaaaaaa" + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + }, + "sku": { + "name": "Classic", + "tier": "aaaaaaaaaaaaaa", + "capacity": 29 + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet", + "name": "myAvailabilitySet", + "type": "Microsoft.Compute/availabilitySets", + "tags": { + "key9626": "aaaaaaaaaaaaaaaaaaaa", + "key2505": "aa" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..606c86b882b7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/availabilitySetExamples/AvailabilitySet_Update_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "availabilitySetName": "aaaaaaaaaaaaaaaaaaaa", + "parameters": {}, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_CreateOrUpdate.json new file mode 100644 index 000000000000..1b02eb6a2b69 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "capacityReservationGroupName": "myCapacityReservationGroup", + "parameters": { + "location": "westus", + "tags": { + "department": "finance" + }, + "zones": [ + "1", + "2" + ], + "properties": { + "sharingProfile": { + "subscriptionIds": [ + { + "id": "/subscriptions/{subscription-id1}" + }, + { + "id": "/subscriptions/{subscription-id2}" + } + ] + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myCapacityReservationGroup", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/myCapacityReservationGroup", + "tags": { + "department": "finance" + }, + "zones": [ + "1", + "2" + ], + "properties": { + "sharingProfile": { + "subscriptionIds": [ + { + "id": "/subscriptions/{subscription-id1}" + }, + { + "id": "/subscriptions/{subscription-id2}" + } + ] + } + } + } + }, + "200": { + "body": { + "location": "westus", + "tags": { + "department": "finance", + "owner": "myCompany" + }, + "name": "myCapacityReservationGroup", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/myCapacityReservationGroup", + "zones": [ + "1", + "2" + ], + "properties": { + "sharingProfile": { + "subscriptionIds": [ + { + "id": "/subscriptions/{subscription-id1}" + }, + { + "id": "/subscriptions/{subscription-id2}" + } + ] + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..cc10b203d764 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "capacityReservationGroupName": "a", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..476c8b5b1cf5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Delete_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "capacityReservationGroupName": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Get.json new file mode 100644 index 000000000000..255d1c25b22f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Get.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "capacityReservationGroupName": "myCapacityReservationGroup", + "$expand": "instanceView" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/myCapacityReservationGroup", + "properties": { + "capacityReservations": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation1" + }, + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation2" + } + ], + "sharingProfile": { + "subscriptionIds": [ + { + "id": "/subscriptions/{subscription-id1}" + }, + { + "id": "/subscriptions/{subscription-id2}" + } + ] + }, + "instanceView": { + "capacityReservations": [ + { + "name": "myCapacityReservation1", + "utilizationInfo": { + "currentCapacity": 5, + "virtualMachinesAllocated": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2" + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + } + ] + }, + { + "name": "myCapacityReservation2", + "utilizationInfo": { + "currentCapacity": 5, + "virtualMachinesAllocated": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM4" + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + } + ] + } + ], + "sharedSubscriptionIds": [ + { + "id": "/subscriptions/{subscription-id1}" + }, + { + "id": "/subscriptions/{subscription-id2}" + } + ] + } + }, + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "name": "myCapacityReservationGroup", + "zones": [ + "3", + "1" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_ListByResourceGroup.json new file mode 100644 index 000000000000..9eccb3626106 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "$expand": "virtualMachines/$ref" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{capacityReservationGroupName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", + "type": "Microsoft.Compute/CapacityReservationGroups", + "location": "West US", + "properties": { + "capacityReservations": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation1" + }, + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation2" + } + ], + "virtualMachinesAssociated": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2" + } + ] + } + }, + { + "name": "{capacityReservationGroupName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", + "type": "Microsoft.Compute/CapacityReservationGroups", + "location": "West US", + "properties": { + "capacityReservations": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation3" + }, + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation4" + } + ], + "virtualMachinesAssociated": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_ListBySubscription.json new file mode 100644 index 000000000000..3fe4c0b44c74 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2023-09-01", + "$expand": "virtualMachines/$ref" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{capacityReservationGroupName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup1/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", + "type": "Microsoft.Compute/CapacityReservationGroups", + "location": "West US", + "properties": { + "capacityReservations": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup1/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation1" + }, + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup1/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation2" + } + ], + "virtualMachinesAssociated": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup1/providers/Microsoft.Compute/virtualMachines/myVM1" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup1/providers/Microsoft.Compute/virtualMachines/myVM2" + } + ] + } + }, + { + "name": "{capacityReservationGroupName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}", + "type": "Microsoft.Compute/CapacityReservationGroups", + "location": "West US", + "properties": { + "capacityReservations": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation3" + }, + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation4" + } + ], + "virtualMachinesAssociated": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup2/providers/Microsoft.Compute/virtualMachines/myVM3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..15357516182b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MaximumSet_Gen.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "capacityReservationGroupName": "aaaaaaaaaaaaaaaaaaaaaa", + "parameters": { + "properties": { + "instanceView": {} + }, + "tags": { + "key5355": "aaa" + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "tags": {}, + "zones": [ + "1", + "2" + ], + "properties": { + "capacityReservations": [ + { + "id": "aaaa" + } + ], + "virtualMachinesAssociated": [ + { + "id": "aaaa" + } + ], + "instanceView": { + "capacityReservations": [ + { + "name": "aaaaaaaaaaaaaaaa", + "utilizationInfo": { + "virtualMachinesAllocated": [ + { + "id": "aaaa" + } + ] + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ] + } + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/myCapacityReservationGroup", + "name": "myCapacityReservationGroup", + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..cec2b8d07cbb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservationGroup_Update_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "capacityReservationGroupName": "aaaaaaaaaaaaaaaaaaaaaa", + "parameters": {}, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_CreateOrUpdate.json new file mode 100644 index 000000000000..6ce02bc5cc8e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_CreateOrUpdate.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "tags": { + "department": "HR" + }, + "sku": { + "name": "Standard_DS1_v2", + "capacity": 4 + }, + "zones": [ + "1" + ] + }, + "capacityReservationGroupName": "myCapacityReservationGroup", + "capacityReservationName": "myCapacityReservation" + }, + "responses": { + "201": { + "body": { + "name": "myCapacityReservation", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation", + "tags": { + "department": "HR" + }, + "sku": { + "name": "Standard_DS1_v2", + "capacity": 4 + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "reservationId": "{GUID}", + "provisioningState": "Creating", + "provisioningTime": "2021-06-27T01:02:38.3138469+00:00" + } + } + }, + "200": { + "body": { + "name": "myCapacityReservation", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation", + "tags": { + "department": "HR" + }, + "sku": { + "name": "Standard_DS1_v2", + "capacity": 4 + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "reservationId": "{GUID}", + "provisioningState": "Creating", + "provisioningTime": "2021-06-27T01:02:38.3138469+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..73e1cfed3682 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "capacityReservationGroupName": "aaaaaaaaaaa", + "capacityReservationName": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..f279944abb76 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "capacityReservationGroupName": "aaa", + "capacityReservationName": "aaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Get.json new file mode 100644 index 000000000000..88ff3ff0546a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Get.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "capacityReservationGroupName": "myCapacityReservationGroup", + "capacityReservationName": "myCapacityReservation", + "$expand": "instanceView" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation", + "properties": { + "platformFaultDomainCount": 3, + "reservationId": "{GUID}", + "provisioningTime": "2021-06-27T01:02:38.3138469+00:00", + "virtualMachinesAssociated": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3" + } + ], + "provisioningState": "Succeeded", + "instanceView": { + "utilizationInfo": { + "currentCapacity": 5, + "virtualMachinesAllocated": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2" + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + } + ] + }, + "timeCreated": "2021-06-27T01:02:38.3138469+00:00" + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "sku": { + "name": "Standard_DS1_v2", + "capacity": 4 + }, + "zones": [ + "1" + ], + "name": "myCapacityReservation" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_ListByReservationGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_ListByReservationGroup.json new file mode 100644 index 000000000000..5c4cad1d26d3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_ListByReservationGroup.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "capacityReservationGroupName": "myCapacityReservationGroup", + "api-version": "2023-09-01", + "$expand": "virtualMachines/$ref" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{capacityReservationName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/CapacityReservation/{capacityReservationName}", + "type": "Microsoft.Compute/CapacityReservations", + "location": "West US", + "properties": { + "platformFaultDomainCount": 3, + "reservationId": "{GUID}", + "provisioningTime": "2021-06-27T01:02:38.3138469+00:00", + "virtualMachinesAssociated": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM1" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM2" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM3" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "department": "HR" + }, + "sku": { + "name": "Standard_DS1_v2", + "capacity": 4 + }, + "zones": [ + "1" + ] + }, + { + "name": "{capacityReservationName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}/CapacityReservation/{capacityReservationName}", + "type": "Microsoft.Compute/CapacityReservations", + "location": "West US", + "properties": { + "platformFaultDomainCount": 3, + "reservationId": "{GUID}", + "provisioningTime": "2021-06-27T01:02:38.3138469+00:00", + "virtualMachinesAssociated": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM4" + } + ], + "provisioningState": "Succeeded" + }, + "tags": { + "department": "HR" + }, + "sku": { + "name": "Standard_A1_v2", + "capacity": 4 + }, + "zones": [ + "1" + ] + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..87a5ebc4df28 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Update_MaximumSet_Gen.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "capacityReservationGroupName": "aaaaaaaaaa", + "capacityReservationName": "aaaaaaaaaaaaaaaaaaa", + "parameters": { + "properties": { + "instanceView": { + "utilizationInfo": {}, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + }, + "sku": { + "name": "Standard_DS1_v2", + "tier": "aaa", + "capacity": 7 + }, + "tags": { + "key4974": "aaaaaaaaaaaaaaaa" + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "tags": {}, + "sku": { + "name": "Standard_DS1_v2", + "capacity": 4, + "tier": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "reservationId": "{GUID}", + "virtualMachinesAssociated": [ + { + "id": "aaaa" + } + ], + "provisioningTime": "2021-06-27T01:02:38.3138469+00:00", + "provisioningState": "Creating", + "instanceView": { + "utilizationInfo": { + "virtualMachinesAllocated": [ + { + "id": "aaaa" + } + ] + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/capacityReservationGroups/myCapacityReservationGroup/capacityReservations/myCapacityReservation", + "name": "myCapacityReservation", + "type": "aaaaaaaaaaaaaaa" + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..51d641eefb18 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/capacityReservationExamples/CapacityReservation_Update_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "capacityReservationGroupName": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "capacityReservationName": "aaa", + "parameters": {}, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "sku": {} + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Operations_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..bc3ace48e1b5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "origin": "aaaaa", + "name": "aaaaaaaaaaaa", + "display": { + "operation": "aaaaaaaaaaaaaaaaaaaaaa", + "resource": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "description": "aaaaaaaaaaaaaaaaaaaaaa", + "provider": "aaaaaaaaaaaaaaaaaa" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Operations_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..5ac5b85f29a9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..100d9f18a89f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Usage_List_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "location": "4_.", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 17, + "limit": 19, + "name": { + "value": "aaaaaaaaaaaaaaaaaa", + "localizedValue": "aaaaaaaaaaaaaa" + } + } + ], + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..1b584e800e77 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/Usage_List_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "location": "_--", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 17, + "limit": 19, + "name": {} + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..34bd5784ffa0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "location": "-e", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_A1_V2", + "numberOfCores": 1, + "osDiskSizeInMB": 1047552, + "resourceDiskSizeInMB": 10240, + "memoryInMB": 2048, + "maxDataDiskCount": 2 + }, + { + "name": "Standard_A2_V2", + "numberOfCores": 2, + "osDiskSizeInMB": 1047552, + "resourceDiskSizeInMB": 20480, + "memoryInMB": 4096, + "maxDataDiskCount": 4 + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..5e93b8664e61 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/computeRPCommonExamples/VirtualMachineSizes_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "location": "._..", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json new file mode 100644 index 000000000000..ed5837585aa1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "hostGroupName": "myDedicatedHostGroup", + "parameters": { + "location": "westus", + "tags": { + "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true + } + } + }, + "responses": { + "201": { + "body": { + "name": "myDedicatedHostGroup", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "tags": { + "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true + } + } + }, + "200": { + "body": { + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true + }, + "location": "westus", + "tags": { + "department": "finance", + "owner": "myCompany" + }, + "name": "myDedicatedHostGroup", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json new file mode 100644 index 000000000000..371050515ef6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_CreateOrUpdate_WithUltraSSD.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "hostGroupName": "myDedicatedHostGroup", + "parameters": { + "location": "westus", + "tags": { + "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true, + "additionalCapabilities": { + "ultraSSDEnabled": true + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myDedicatedHostGroup", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "tags": { + "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true, + "additionalCapabilities": { + "ultraSSDEnabled": true + } + } + } + }, + "200": { + "body": { + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true, + "additionalCapabilities": { + "ultraSSDEnabled": true + } + }, + "location": "westus", + "tags": { + "department": "finance", + "owner": "myCompany" + }, + "name": "myDedicatedHostGroup", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..e275bd9984bd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "a", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..6e705e7b8763 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Delete_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "aaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get.json new file mode 100644 index 000000000000..b112d51b9421 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "hostGroupName": "myDedicatedHostGroup", + "expand": "instanceView" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "properties": { + "platformFaultDomainCount": 3, + "hosts": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1" + }, + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2" + } + ], + "supportAutomaticPlacement": true, + "instanceView": { + "hosts": [ + { + "name": "myHost1", + "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + }, + { + "name": "myHost2", + "assetId": "f293d4ac-5eea-4be2-b0c0-0fcaa09aebf8", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + } + ] + } + }, + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "name": "myDedicatedHostGroup", + "zones": [ + "3" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get_UltraSSDEnabledDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get_UltraSSDEnabledDedicatedHostGroup.json new file mode 100644 index 000000000000..f33aee35bbb1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Get_UltraSSDEnabledDedicatedHostGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "hostGroupName": "myDedicatedHostGroup", + "expand": "instanceView" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "properties": { + "platformFaultDomainCount": 3, + "hosts": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost" + } + ], + "supportAutomaticPlacement": true, + "additionalCapabilities": { + "ultraSSDEnabled": true + }, + "instanceView": { + "hosts": [ + { + "name": "myHost", + "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + } + ] + } + }, + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "name": "myDedicatedHostGroup", + "zones": [ + "3" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..36a009a51512 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "tags": {}, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true, + "hosts": [ + { + "id": "aaaa" + } + ], + "instanceView": { + "hosts": [ + { + "name": "aaaaaaaaaaaaaaaaaa", + "assetId": "aaaa", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "aaaaaaaaaaaaaaaaaaaa", + "count": 26 + } + ] + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ] + } + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "name": "myDedicatedHostGroup", + "type": "aaaa" + } + ], + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..b7647421c4f8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "location": "westus" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..b6273c30191e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "tags": {}, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true, + "hosts": [ + { + "id": "aaaa" + } + ], + "instanceView": { + "hosts": [ + { + "name": "aaaaaaaaaaaaaaaaaa", + "assetId": "aaaa", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "aaaaaaaaaaaaaaaaaaaa", + "count": 26 + } + ] + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ] + } + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "name": "myDedicatedHostGroup", + "type": "aaaa" + } + ], + "nextLink": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..173e1130257d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..f72b9eb8819d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Update_MaximumSet_Gen.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "aaaa", + "parameters": { + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true, + "instanceView": { + "hosts": [ + { + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "aaaaaaaaaaaaaaaaaaaa", + "count": 26 + } + ] + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ] + } + }, + "zones": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "tags": { + "key9921": "aaaaaaaaaa" + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "tags": {}, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true, + "hosts": [ + { + "id": "aaaa" + } + ], + "instanceView": { + "hosts": [ + { + "name": "aaaaaaaaaaaaaaaaaa", + "assetId": "aaaa", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "aaaaaaaaaaaaaaaaaaaa", + "count": 26 + } + ] + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ] + } + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "name": "myDedicatedHostGroup", + "type": "aaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..e3494f7982b1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHostGroup_Update_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "aaaaaaaaaaa", + "parameters": {}, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json new file mode 100644 index 000000000000..033c7c6f361d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "tags": { + "department": "HR" + }, + "properties": { + "platformFaultDomain": 1 + }, + "sku": { + "name": "DSv3-Type1" + } + }, + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myDedicatedHost" + }, + "responses": { + "201": { + "body": { + "name": "myDedicatedHost", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}" + } + } + }, + "200": { + "body": { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": false, + "licenseType": "Windows_Server_Hybrid", + "hostId": "{GUID}" + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "name": "myDedicatedHost", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "sku": { + "name": "DSv3-Type1" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a9beacaa9817 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "aaaaaa", + "hostName": "aaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..da1460aa4c0b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "aaaaaaaaaaaaaaa", + "hostName": "aaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Get.json new file mode 100644 index 000000000000..3e40fb34d7b9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Get.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myHost", + "$expand": "instanceView" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost", + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + "provisioningTime": "2019-06-27T01:02:38.3138469+00:00", + "virtualMachines": [ + { + "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1" + } + ], + "provisioningState": "Succeeded", + "instanceView": { + "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + }, + "timeCreated": "2019-06-27T01:02:38.3138469+00:00" + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "name": "myHost" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_ListAvailableSizes.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_ListAvailableSizes.json new file mode 100644 index 000000000000..4aac232be173 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_ListAvailableSizes.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myHost" + }, + "responses": { + "200": { + "body": { + "value": [ + "Dsv3-Type1", + "Esv3-Type1" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..82ba0ec9a09c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MaximumSet_Gen.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "tags": {}, + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + "virtualMachines": [ + { + "id": "aaaa" + } + ], + "licenseType": "Windows_Server_Hybrid", + "provisioningTime": "2021-11-30T12:58:26.526Z", + "provisioningState": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "instanceView": { + "assetId": "aaaaaaaaaaaaaaaa", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "aaaaaaaaaaaaaaaaaaaa", + "count": 26 + } + ] + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + }, + "sku": { + "name": "DSv3-Type1", + "tier": "aaa", + "capacity": 7 + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "name": "myDedicatedHost", + "type": "aaaaaaaaaaaaaaaaaaa" + } + ], + "nextLink": "aaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..ff32f7b917ce --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_ListByHostGroup_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "aaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "sku": {}, + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Redeploy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Redeploy.json new file mode 100644 index 000000000000..4f6c2efb8d16 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Redeploy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myHost" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Restart.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Restart.json new file mode 100644 index 000000000000..00a43ca6550d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Restart.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myHost" + }, + "responses": { + "200": { + "description": "OK" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..cc82af0bc88e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Update_MaximumSet_Gen.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "aaaaaaaaa", + "hostName": "aaaaaaaaaaaaaaaaaaaaa", + "parameters": { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "licenseType": "Windows_Server_Hybrid", + "instanceView": { + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "aaaaaaaaaaaaaaaaaaaa", + "count": 26 + } + ] + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + }, + "tags": { + "key8813": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "tags": {}, + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + "virtualMachines": [ + { + "id": "aaaa" + } + ], + "licenseType": "Windows_Server_Hybrid", + "provisioningTime": "2021-11-30T12:58:26.526Z", + "provisioningState": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "instanceView": { + "assetId": "aaaaaaaaaaaaaaaa", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "aaaaaaaaaaaaaaaaaaaa", + "count": 26 + } + ] + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + }, + "sku": { + "name": "DSv3-Type1", + "tier": "aaa", + "capacity": 7 + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "name": "myDedicatedHost", + "type": "aaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..d43f363deebc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Update_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "aa", + "hostName": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "parameters": {}, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "sku": {} + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Update_Resize.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Update_Resize.json new file mode 100644 index 000000000000..cb77e4bdb536 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/dedicatedHostExamples/DedicatedHost_Update_Resize.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "hostGroupName": "aaaaaaaaa", + "hostName": "aaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "name": "DSv3-Type1" + } + }, + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "tags": {}, + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + "virtualMachines": [ + { + "id": "aaaa" + } + ], + "licenseType": "Windows_Server_Hybrid", + "provisioningTime": "2021-11-30T12:58:26.526Z", + "provisioningState": "aaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "sku": { + "name": "DSv3-Type1", + "tier": "aaa", + "capacity": 7 + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "name": "myDedicatedHost", + "type": "aaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromABlob.json new file mode 100644 index 000000000000..d9f3a2bbfb41 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromABlob.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + }, + "zoneResilient": true + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromABlobWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromABlobWithDiskEncryptionSet.json new file mode 100644 index 000000000000..4b83334a1315 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromABlobWithDiskEncryptionSet.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromAManagedDisk.json new file mode 100644 index 000000000000..645c1ff9c004 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromAManagedDisk.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + }, + "zoneResilient": true + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromAManagedDiskWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromAManagedDiskWithDiskEncryptionSet.json new file mode 100644 index 000000000000..53e661c8f793 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromAManagedDiskWithDiskEncryptionSet.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromASnapshot.json new file mode 100644 index 000000000000..7e36432b4638 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromASnapshot.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + }, + "zoneResilient": false + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromASnapshotWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromASnapshotWithDiskEncryptionSet.json new file mode 100644 index 000000000000..6f7cae21952c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromASnapshotWithDiskEncryptionSet.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromAVM.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromAVM.json new file mode 100644 index 000000000000..2f6966c53a8f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_CreateFromAVM.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Create_DataDiskFromABlobIncluded.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Create_DataDiskFromABlobIncluded.json new file mode 100644 index 000000000000..f8c2a778995d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Create_DataDiskFromABlobIncluded.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ], + "zoneResilient": false + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Create_DataDiskFromAManagedDiskIncluded.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Create_DataDiskFromAManagedDiskIncluded.json new file mode 100644 index 000000000000..9aff827f1ec3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Create_DataDiskFromAManagedDiskIncluded.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ], + "zoneResilient": false + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Create_DataDiskFromASnapshotIncluded.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Create_DataDiskFromASnapshotIncluded.json new file mode 100644 index 000000000000..fc1b81e59ea8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Create_DataDiskFromASnapshotIncluded.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ], + "zoneResilient": true + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Get.json new file mode 100644 index 000000000000..287b171636b1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_ListByResourceGroup.json new file mode 100644 index 000000000000..0809555f74ec --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_ListByResourceGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/UserVMImages/myImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_ListBySubscription.json new file mode 100644 index 000000000000..6c4d6835f509 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_ListBySubscription.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/UserVMImages/myImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Update.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Update.json new file mode 100644 index 000000000000..654e17d2dca6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Image_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "imageName": "myImage", + "parameters": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "hyperVGeneration": "V1" + }, + "tags": { + "department": "HR" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "tags": { + "department": "HR" + }, + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "tags": { + "department": "HR" + }, + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Images_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Images_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..35674f918fd8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Images_Delete_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "imageName": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Images_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Images_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..9b6d5fb039fa --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/imageExamples/Images_Delete_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "imageName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json new file mode 100644 index 000000000000..8b881ee91023 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2023-09-01", + "parameters": { + "intervalLength": "FiveMins", + "blobContainerSasUri": "https://somesasuri", + "fromTime": "2018-01-21T01:54:06.862601Z", + "toTime": "2018-01-23T01:54:06.862601Z", + "groupByResourceName": true + } + }, + "responses": { + "200": { + "body": { + "properties": { + "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/RequestRateByInterval_20180121-0154_20180123-0154.csv" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/logAnalyticExamples/LogAnalytics_ThrottledRequests.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/logAnalyticExamples/LogAnalytics_ThrottledRequests.json new file mode 100644 index 000000000000..25ce4ac0a532 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/logAnalyticExamples/LogAnalytics_ThrottledRequests.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2023-09-01", + "parameters": { + "blobContainerSasUri": "https://somesasuri", + "fromTime": "2018-01-21T01:54:06.862601Z", + "toTime": "2018-01-23T01:54:06.862601Z", + "groupByOperationName": true, + "groupByResourceName": false, + "groupByClientApplicationId": false, + "groupByUserAgent": false + } + }, + "responses": { + "200": { + "body": { + "properties": { + "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/ThrottledRequests_20180121-0154_20180123-0154.csv" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_CreateOrUpdate.json new file mode 100644 index 000000000000..252f502019d6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_CreateOrUpdate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": { + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "proximityPlacementGroupType": "Standard", + "intent": { + "vmSizes": [ + "Basic_A0", + "Basic_A2" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "intent": { + "vmSizes": [ + "Basic_A0", + "Basic_A2" + ] + } + }, + "location": "westus", + "zones": [ + "1" + ], + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + }, + "201": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "intent": { + "vmSizes": [ + "Basic_A0", + "Basic_A2" + ] + } + }, + "location": "westus", + "zones": [ + "1" + ], + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Delete.json new file mode 100644 index 000000000000..078f15ed7e2c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": {} + }, + "responses": { + "200": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Get.json new file mode 100644 index 000000000000..ca2c562557e8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "intent": { + "vmSizes": [ + "Basic_A0", + "Basic_A2" + ] + }, + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "zones": [ + "1" + ], + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListByResourceGroup.json new file mode 100644 index 000000000000..2a3f0a49faeb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "intent": { + "vmSizes": [ + "Basic_A0", + "Basic_A2" + ] + }, + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "zones": [ + "1" + ], + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListBySubscription.json new file mode 100644 index 000000000000..f2339e31d591 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2023-09-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "intent": { + "vmSizes": [ + "Basic_A0", + "Basic_A2" + ] + }, + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "zones": [ + "1" + ], + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Patch.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Patch.json new file mode 100644 index 000000000000..324d79692baa --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Patch.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": { + "tags": { + "additionalProp1": "string" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard" + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate.json new file mode 100644 index 000000000000..aeb3979f9b30 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "myRpc", + "api-version": "2023-09-01", + "parameters": { + "location": "norwayeast", + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + } + }, + "tags": { + "myTag1": "tagValue1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myRpc", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc", + "type": "Microsoft.Compute/restorePointCollections", + "location": "norwayeast", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "eastus" + }, + "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "myRpc", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc", + "type": "Microsoft.Compute/restorePointCollections", + "location": "norwayeast", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "eastus" + }, + "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate_ForCrossRegionCopy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate_ForCrossRegionCopy.json new file mode 100644 index 000000000000..9581141933bf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_CreateOrUpdate_ForCrossRegionCopy.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "myRpc", + "api-version": "2023-09-01", + "parameters": { + "location": "norwayeast", + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName" + } + }, + "tags": { + "myTag1": "tagValue1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myRpc", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc", + "type": "Microsoft.Compute/restorePointCollections", + "location": "norwayeast", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "eastus" + }, + "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "myRpc", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc", + "type": "Microsoft.Compute/restorePointCollections", + "location": "norwayeast", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "source": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName", + "location": "eastus" + }, + "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..294e76103df0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Delete_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "rgcompute", + "restorePointCollectionName": "aaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..518e95e99842 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Delete_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "rgcompute", + "restorePointCollectionName": "aaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Get.json new file mode 100644 index 000000000000..acf98c740996 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "myRpc", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "name": "myRpc", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc", + "type": "Microsoft.Compute/restorePointCollections", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc", + "location": "eastus" + }, + "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json new file mode 100644 index 000000000000..0c725abd602d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpcName", + "api-version": "2023-09-01", + "expand": "restorePoints" + }, + "responses": { + "200": { + "body": { + "name": "rpcName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName", + "type": "Microsoft.Compute/restorePointCollections", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "eastus" + }, + "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4", + "provisioningState": "Succeeded", + "restorePoints": [ + { + "name": "restorePointName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName", + "properties": { + "excludeDisks": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f" + } + ], + "sourceMetadata": { + "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7", + "hardwareProfile": { + "vmSize": "Standard_B1s" + }, + "storageProfile": { + "osDisk": { + "osType": "Windows", + "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57" + } + }, + "dataDisks": [ + { + "lun": 1, + "name": "testingexcludedisk_DataDisk_1", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5" + } + } + ], + "diskControllerType": "NVMe" + }, + "osProfile": { + "computerName": "computerName", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "location": "westus" + }, + "provisioningState": "Succeeded", + "consistencyMode": "ApplicationConsistent", + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" + } + } + ] + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_ListByResourceGroup.json new file mode 100644 index 000000000000..d35a93e6e6e6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_ListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "restorePointCollection1", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1", + "type": "Microsoft.Compute/restorePointCollections", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1", + "location": "westus" + }, + "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4", + "provisioningState": "Succeeded" + } + }, + { + "name": "restorePointCollection2", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2", + "type": "Microsoft.Compute/restorePointCollections", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2", + "location": "westus" + }, + "restorePointCollectionId": "2875c590-e337-4102-9668-4f5b7e3f98a4", + "provisioningState": "Deleting" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_ListBySubscription.json new file mode 100644 index 000000000000..758fecbdff27 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "restorePointCollection1", + "id": "/subscriptions/{subscription-id}/resourceGroups/resourceGroup1/providers/Microsoft.Compute/restorePointCollections/restorePointCollection1", + "type": "Microsoft.Compute/restorePointCollections", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/VM_Test", + "location": "westus" + }, + "restorePointCollectionId": "59f04a5d-f783-4200-a1bd-d3f464e8c4b4", + "provisioningState": "Succeeded" + } + }, + { + "name": "restorePointCollection2", + "id": "/subscriptions/{subscription-id}/resourceGroups/resourceGroup2/providers/Microsoft.Compute/restorePointCollections/restorePointCollection2", + "type": "Microsoft.Compute/restorePointCollections", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/VM_Prod", + "location": "westus" + }, + "restorePointCollectionId": "2875c590-e337-4102-9668-4f5b7e3f98a4", + "provisioningState": "Deleting" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..529476a5ab1b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Update_MaximumSet_Gen.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "rgcompute", + "restorePointCollectionName": "aaaaaaaaaaaaaaaaaaaa", + "parameters": { + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + } + }, + "tags": { + "key8536": "aaaaaaaaaaaaaaaaaaa" + } + }, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "location": "norwayeast", + "properties": { + "source": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "eastus" + }, + "provisioningState": "Successful", + "restorePointCollectionId": "638f052b-a7c2-450c-89e7-6a3b8f1d6a7c", + "restorePoints": [ + { + "properties": { + "excludeDisks": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57" + } + ], + "sourceMetadata": { + "hardwareProfile": { + "vmSize": "Standard_B1s", + "vmSizeProperties": { + "vCPUsAvailable": 9, + "vCPUsPerCore": 12 + } + }, + "storageProfile": { + "osDisk": { + "osType": "Windows", + "encryptionSettings": { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + }, + "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f", + "caching": "ReadWrite", + "diskSizeGB": 3, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57" + } + }, + "dataDisks": [ + { + "lun": 1, + "name": "testingexcludedisk_DataDisk_1", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5" + }, + "diskSizeGB": 24 + } + ], + "diskControllerType": "NVMe" + }, + "osProfile": { + "computerName": "computerName", + "adminUsername": "admin", + "customData": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaa", + "keyData": "aaaaaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "aaaaaaa", + "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaaaaaaaa" + } + }, + "licenseType": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7", + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "location": "westus" + }, + "provisioningState": "aaaaaaaaaaaaaaaaa", + "consistencyMode": "CrashConsistent", + "timeCreated": "2021-11-30T12:58:26.593Z" + }, + "id": "aaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + }, + "tags": {}, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/myRpc", + "name": "myRpc", + "type": "Microsoft.Compute/restorePointCollections" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..6cfd2043f200 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePointCollection_Update_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "rgcompute", + "restorePointCollectionName": "aaaaaaaaaaaaaaaaaa", + "parameters": {}, + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "location": "norwayeast" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.json new file mode 100644 index 000000000000..808922ced1ef --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpcName", + "restorePointName": "rpName", + "api-version": "2023-09-01", + "parameters": { + "properties": { + "sourceRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "rpName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName", + "properties": { + "sourceRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/sourceRpcName/restorePoints/sourceRpName" + }, + "sourceMetadata": { + "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7", + "hardwareProfile": { + "vmSize": "Standard_B1s" + }, + "storageProfile": { + "osDisk": { + "osType": "Windows", + "name": "osDisk123", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57" + } + }, + "dataDisks": [ + { + "lun": 1, + "name": "dataDisk123", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5" + } + } + ], + "diskControllerType": "NVMe" + }, + "osProfile": { + "computerName": "computerName", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "location": "westus", + "userData": "c2FtcGxlIHVzZXJEYXRh" + }, + "provisioningState": "Creating", + "consistencyMode": "ApplicationConsistent", + "timeCreated": "2021-10-25T23:54:29.2796325+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Create.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Create.json new file mode 100644 index 000000000000..38908d537b08 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Create.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpcName", + "restorePointName": "rpName", + "api-version": "2023-09-01", + "parameters": { + "properties": { + "excludeDisks": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "rpName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName", + "properties": { + "excludeDisks": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123" + } + ], + "sourceMetadata": { + "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7", + "hardwareProfile": { + "vmSize": "Standard_B1s" + }, + "storageProfile": { + "osDisk": { + "osType": "Windows", + "name": "osDisk123", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/osDisk123" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/osDisk123_22b4bdfe-6c54-4f72-84d8-85d8860f0c57" + } + }, + "dataDisks": [ + { + "lun": 1, + "name": "dataDisk123", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/dataDisk123" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/dataDisk123_68785190-1acb-4d5e-a8ae-705b45f3dca5" + } + } + ], + "diskControllerType": "NVMe" + }, + "osProfile": { + "computerName": "computerName", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "location": "westus", + "userData": "c2FtcGxlIHVzZXJEYXRh" + }, + "provisioningState": "Succeeded", + "consistencyMode": "ApplicationConsistent", + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d9e538cf1549 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "rgcompute", + "restorePointCollectionName": "aaaaaaaaaaaaaaaaaaaaaa", + "restorePointName": "a", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..6a5b1ba9bcae --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "rgcompute", + "restorePointCollectionName": "aaaaaaaaaaaaaaaaa", + "restorePointName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Get.json new file mode 100644 index 000000000000..ebf46254c064 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpcName", + "restorePointName": "rpName", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "name": "rpName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName", + "properties": { + "excludeDisks": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f" + } + ], + "sourceMetadata": { + "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7", + "hardwareProfile": { + "vmSize": "Standard_B1s" + }, + "storageProfile": { + "osDisk": { + "osType": "Windows", + "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57" + } + }, + "dataDisks": [ + { + "lun": 1, + "name": "testingexcludedisk_DataDisk_1", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5" + } + } + ], + "diskControllerType": "NVMe" + }, + "osProfile": { + "computerName": "computerName", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "location": "westus" + }, + "provisioningState": "Succeeded", + "consistencyMode": "ApplicationConsistent", + "timeCreated": "2021-01-27T20:35:05.8401519+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json new file mode 100644 index 000000000000..d2d3695e599a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "restorePointCollectionName": "rpcName", + "restorePointName": "rpName", + "api-version": "2023-09-01", + "expand": "instanceView" + }, + "responses": { + "200": { + "body": { + "name": "rpName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName", + "properties": { + "excludeDisks": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vm8768_disk2_fe6ffde4f69b491ca33fb984d5bcd89f" + } + ], + "sourceMetadata": { + "vmId": "76d6541e-80bd-4dc1-932b-3cae4cfb80e7", + "hardwareProfile": { + "vmSize": "Standard_B1s" + }, + "storageProfile": { + "osDisk": { + "osType": "Windows", + "name": "testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57" + } + }, + "dataDisks": [ + { + "lun": 1, + "name": "testingexcludedisk_DataDisk_1", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/disks/testingexcludedisk_DataDisk_1" + }, + "diskRestorePoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5" + } + } + ], + "diskControllerType": "NVMe" + }, + "osProfile": { + "computerName": "computerName", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "location": "westus" + }, + "provisioningState": "Succeeded", + "consistencyMode": "ApplicationConsistent", + "timeCreated": "2021-01-27T20:35:05.8401519+00:00", + "instanceView": { + "diskRestorePoints": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/rpName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57", + "replicationStatus": { + "status": { + "code": "ReplicationState/succeeded", + "level": "Info", + "displayStatus": "Succeeded" + }, + "completionPercent": 100 + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/userdata/providers/Microsoft.Compute/restorePointCollections/mynewrpc/restorePoints/restorepointtwo/diskRestorePoints/testingexcludedisk_DataDisk_1_68785190-1acb-4d5e-a8ae-705b45f3dca5", + "replicationStatus": { + "status": { + "code": "ReplicationState/succeeded", + "level": "Info", + "displayStatus": "Succeeded" + }, + "completionPercent": 100 + } + } + ], + "statuses": [ + { + "code": "ReplicationState/succeeded", + "level": "Info", + "displayStatus": "Succeeded" + } + ] + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/RunCommand_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/RunCommand_Get.json new file mode 100644 index 000000000000..e07c38f27c0b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/RunCommand_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "location": "SoutheastAsia", + "commandId": "RunPowerShellScript", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "script": [ + "param(", + " [string]$arg1,", + " [string]$arg2", + ")", + "Write-Host This is a sample script with parameters $arg1 $arg2" + ], + "parameters": [ + { + "name": "arg1", + "type": "string", + "defaultValue": "value1" + }, + { + "name": "arg2", + "type": "string", + "defaultValue": "value2" + } + ], + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunPowerShellScript", + "osType": "Windows", + "label": "Executes a PowerShell script", + "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/RunCommand_List.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/RunCommand_List.json new file mode 100644 index 000000000000..b00149787713 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/RunCommand_List.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "SoutheastAsia", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "EnableRemotePS", + "osType": "Windows", + "label": "Enable remote PowerShell", + "description": "Configure the machine to enable remote PowerShell." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "IPConfig", + "osType": "Windows", + "label": "List IP configuration", + "description": "Shows detailed information for the IP address, subnet mask and default gateway for each adapter bound to TCP/IP." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunPowerShellScript", + "osType": "Windows", + "label": "Executes a PowerShell script", + "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunShellScript", + "osType": "Linux", + "label": "Executes a Linux shell script", + "description": "Custom multiline shell script should be defined in script property. Optional parameters can be set in parameters property." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ifconfig", + "osType": "Linux", + "label": "List network configuration", + "description": "Get the configuration of all network interfaces." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "EnableAdminAccount", + "osType": "Windows", + "label": "Enable administrator account", + "description": "Checks if the local Administrator account is disabled, and if so enables it." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ResetAccountPassword", + "osType": "Windows", + "label": "Reset built-in Administrator account password", + "description": "Reset built-in Administrator account password." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RDPSettings", + "osType": "Windows", + "label": "Verify RDP Listener Settings", + "description": "Checks registry settings and domain policy settings. Suggests policy actions if machine is part of a domain or modifies the settings to default values." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "SetRDPPort", + "osType": "Windows", + "label": "Set Remote Desktop port", + "description": "Sets the default or user specified port number for Remote Desktop connections. Enables firewall rule for inbound access to the port." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ResetRDPCert", + "osType": "Windows", + "label": "Restore RDP Authentication mode to defaults", + "description": "Removes the SSL certificate tied to the RDP listener and restores the RDP listerner security to default. Use this script if you see any issues with the certificate." + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand.json new file mode 100644 index 000000000000..99ec4d895518 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "resourceGroupName": "crptestar98131", + "vmName": "vm3036", + "$top": 1, + "api-version": "2023-09-01", + "monitor": "true", + "parameters": { + "commandId": "RunPowerShellScript" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "ComponentStatus/StdOut/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "This is a sample script with parameters value1 value2" + }, + { + "code": "ComponentStatus/StdErr/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "" + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json new file mode 100644 index 000000000000..84fdae1aebde --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "runCommandName": "myRunCommand", + "api-version": "2023-09-01", + "runCommand": { + "location": "West US", + "properties": { + "source": { + "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": false, + "runAsUser": "user1", + "runAsPassword": "", + "timeoutInSeconds": 3600, + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/scriptURI", + "outputBlobManagedIdentity": { + "clientId": "22d35efb-0c99-4041-8c5b-6d24db33a69a" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myRunCommand", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand", + "type": "Microsoft.Compute/virtualMachines/runCommands", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "source": { + "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Succeeded", + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + }, + "201": { + "body": { + "name": "myRunCommand", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand", + "type": "Microsoft.Compute/virtualMachines/runCommands", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "source": { + "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Creating", + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_Delete.json new file mode 100644 index 000000000000..ca773e43e830 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "runCommandName": "myRunCommand", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_Get.json new file mode 100644 index 000000000000..9e700a3f7c52 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "runCommandName": "myRunCommand", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "name": "myRunCommand", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand", + "type": "Microsoft.Compute/virtualMachines/runCommands", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "source": { + "script": "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Succeeded", + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json new file mode 100644 index 000000000000..04110ebff4e9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myRunCommand", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand", + "type": "Microsoft.Compute/virtualMachines/runCommands", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "source": { + "script": "Write-Host Hello World!" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": false, + "runAsUser": "user1", + "timeoutInSeconds": 0, + "provisioningState": "Succeeded", + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.json new file mode 100644 index 000000000000..a0f04de99a77 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineRunCommand_Update.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "runCommandName": "myRunCommand", + "api-version": "2023-09-01", + "runCommand": { + "properties": { + "source": { + "script": "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "runAsUser": "user1", + "runAsPassword": "", + "timeoutInSeconds": 3600, + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/outputUri", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt", + "errorBlobManagedIdentity": { + "objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myRunCommand", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/runCommands/myRunCommand", + "type": "Microsoft.Compute/virtualMachines/runCommands", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "source": { + "script": "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Updating", + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json new file mode 100644 index 000000000000..d540d6170f6c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "instanceId": "0", + "api-version": "2023-09-01", + "parameters": { + "commandId": "RunPowerShellScript", + "script": [ + "Write-Host Hello World!" + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "ComponentStatus/StdOut/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Hello World!" + }, + { + "code": "ComponentStatus/StdErr/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "" + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json new file mode 100644 index 000000000000..7a11630c7c06 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "runCommandName": "myRunCommand", + "api-version": "2023-09-01", + "runCommand": { + "location": "West US", + "properties": { + "source": { + "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1", + "scriptUriManagedIdentity": { + "objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072" + } + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": true, + "runAsUser": "user1", + "runAsPassword": "", + "timeoutInSeconds": 3600, + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt", + "outputBlobManagedIdentity": { + "clientId": "22d35efb-0c99-4041-8c5b-6d24db33a69a" + }, + "errorBlobManagedIdentity": {} + } + } + }, + "responses": { + "200": { + "body": { + "name": "myRunCommand", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands", + "location": "westus", + "properties": { + "source": { + "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": true, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Succeeded", + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + }, + "201": { + "body": { + "name": "myRunCommand", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands", + "location": "westus", + "properties": { + "source": { + "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": true, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Creating", + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Delete.json new file mode 100644 index 000000000000..01a4b6c93976 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "runCommandName": "myRunCommand", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Get.json new file mode 100644 index 000000000000..22ccc7765d04 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "runCommandName": "myRunCommand", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "name": "myRunCommand", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "source": { + "scriptUri": "https://gist.githubusercontent.com/myusername/75fd3634w7511116063c60bcc50bee0/raw/04a4c68ac9e1d36asfasdc64bd1d889b104c7abdb8/HelloWorld.ps1" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Succeeded", + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_List.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_List.json new file mode 100644 index 000000000000..c712607d9ff6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myRunCommand", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand", + "properties": { + "source": { + "script": "Write-Host Hello World! ; Remove-Item C:\test\testFile.txt" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": false, + "runAsUser": "user1", + "timeoutInSeconds": 0, + "provisioningState": "Succeeded", + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json new file mode 100644 index 000000000000..c21fda21ba44 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "runCommandName": "myRunCommand", + "api-version": "2023-09-01", + "runCommand": { + "properties": { + "source": { + "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1", + "scriptUriManagedIdentity": { + "objectId": "4231e4d2-33e4-4e23-96b2-17888afa6072" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myRunCommand", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/runCommands/myRunCommand", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "source": { + "scriptUri": "https://mystorageaccount.blob.core.windows.net/scriptcontainer/MyScript.ps1" + }, + "parameters": [ + { + "name": "param1", + "value": "value1" + }, + { + "name": "param2", + "value": "value2" + } + ], + "asyncExecution": false, + "treatFailureAsDeploymentFailure": false, + "runAsUser": "user1", + "timeoutInSeconds": 3600, + "provisioningState": "Updating", + "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt", + "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Create.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Create.json new file mode 100644 index 000000000000..757f0bb9c11a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Create.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "sshPublicKeyName": "mySshPublicKeyName", + "parameters": { + "location": "westus", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mySshPublicKeyName", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + }, + "201": { + "body": { + "name": "mySshPublicKeyName", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..0eb0c3722e58 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Delete_MaximumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "sshPublicKeyName": "aaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..aa4972bab277 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Delete_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "sshPublicKeyName": "aaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair.json new file mode 100644 index 000000000000..5387995a1c06 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "sshPublicKeyName": "mySshPublicKeyName" + }, + "responses": { + "200": { + "body": { + "privateKey": "{ssh private key}", + "publicKey": "{ssh-rsa public key}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithEd25519.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithEd25519.json new file mode 100644 index 000000000000..29a5bcb2c720 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithEd25519.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "sshPublicKeyName": "mySshPublicKeyName", + "parameters": { + "encryptionType": "RSA" + } + }, + "responses": { + "200": { + "body": { + "privateKey": "{ssh private key}", + "publicKey": "{ssh-rsa public key}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithRSA.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithRSA.json new file mode 100644 index 000000000000..b4a19f01ae55 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithRSA.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "sshPublicKeyName": "mySshPublicKeyName", + "parameters": { + "encryptionType": "RSA" + } + }, + "responses": { + "200": { + "body": { + "privateKey": "{ed25519 private key}", + "publicKey": "{ed25519 public key}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Get.json new file mode 100644 index 000000000000..ad53b4b0a403 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "sshPublicKeyName": "mySshPublicKeyName" + }, + "responses": { + "200": { + "body": { + "name": "mySshPublicKeyName", + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListByResourceGroup_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d27ae0a4ec3e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "properties": { + "publicKey": "{ssh-rsa public key}" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", + "name": "mySshPublicKeyName", + "type": "aaaa", + "tags": { + "key6396": "aaaaaaaaaaaaa", + "key8839": "aaa" + } + } + ], + "nextLink": "aaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListByResourceGroup_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListByResourceGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..67d599d73089 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListByResourceGroup_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListBySubscription_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..f5a94b892d6b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "properties": { + "publicKey": "{ssh-rsa public key}" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", + "name": "mySshPublicKeyName", + "type": "aaaa", + "tags": { + "key6396": "aaaaaaaaaaaaa", + "key8839": "aaa" + } + } + ], + "nextLink": "aaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListBySubscription_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListBySubscription_MinimumSet_Gen.json new file mode 100644 index 000000000000..7871284c85da --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_ListBySubscription_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..50f04fc31078 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Update_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "sshPublicKeyName": "aaaaaaaaaaaa", + "parameters": { + "properties": { + "publicKey": "{ssh-rsa public key}" + }, + "tags": { + "key2854": "a" + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "properties": { + "publicKey": "{ssh-rsa public key}" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", + "name": "mySshPublicKeyName", + "type": "aaaa", + "tags": { + "key6396": "aaaaaaaaaaaaa", + "key8839": "aaa" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..4981bca5c385 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/sshPublicKeyExamples/SshPublicKey_Update_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "sshPublicKeyName": "aaaaaaaaaaa", + "parameters": {}, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..23835a4ffee7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "vmExtensionName": "aaaaaaaaaaaaa", + "extensionParameters": { + "location": "westus", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "suppressFailures": true, + "settings": {}, + "forceUpdateTag": "a", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "instanceView": { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + }, + "tags": { + "key9183": "aa" + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "name": "myVMExtension", + "type": "Microsoft.Compute/virtualMachines/extensions", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension", + "location": "westus", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "suppressFailures": true, + "settings": {}, + "forceUpdateTag": "a", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "instanceView": { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + }, + "tags": { + "key9183": "aa" + } + } + }, + "201": { + "headers": { + "location": "https://foo.com/operationstatus" + }, + "body": { + "name": "myVMExtension", + "type": "Microsoft.Compute/virtualMachines/extensions", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension", + "location": "westus", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "suppressFailures": true, + "settings": {}, + "forceUpdateTag": "a", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "instanceView": { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + }, + "tags": { + "key9183": "aa" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..dbca9232f66e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "myVM", + "vmExtensionName": "myVMExtension", + "extensionParameters": { + "location": "westus" + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension" + } + }, + "201": { + "headers": { + "location": "https://foo.com/operationstatus" + }, + "body": { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d1c295e1fb53 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaa", + "vmExtensionName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..c843750d33c0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "vmExtensionName": "aa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9f380c211b4d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MaximumSet_Gen.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmExtensionName": "aaaaaaa", + "$expand": "aaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "name": "myVMExtension", + "type": "Microsoft.Compute/virtualMachines/extensions", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension", + "location": "westus", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "suppressFailures": true, + "settings": {}, + "forceUpdateTag": "a", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "instanceView": { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + }, + "tags": { + "key9183": "aa" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..0a0833d60a9e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Get_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "myVM", + "vmExtensionName": "myVMExtension", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..fd8d03628c4e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_List_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaa", + "$expand": "aaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myVMExtension", + "type": "Microsoft.Compute/virtualMachines/extensions", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension", + "location": "westus", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "suppressFailures": true, + "settings": {}, + "forceUpdateTag": "a", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "instanceView": { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + }, + "tags": { + "key9183": "aa" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..2d6ab36c0101 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_List_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Update.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Update.json new file mode 100644 index 000000000000..181e27d732dc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachineExtension_Update.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "vmExtensionName": "myVMExtension", + "api-version": "2023-09-01", + "extensionParameters": { + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "suppressFailures": true, + "settings": { + "UserName": "xyz@microsoft.com" + }, + "protectedSettingsFromKeyVault": { + "sourceVault": { + "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName" + }, + "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVMExtension", + "type": "Microsoft.Compute/virtualMachines/extensions", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/myVMExtension", + "location": "westus", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "suppressFailures": true, + "settings": { + "UserName": "xyz@microsoft.com" + }, + "protectedSettingsFromKeyVault": { + "sourceVault": { + "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName" + }, + "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_AssessPatches.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_AssessPatches.json new file mode 100644 index 000000000000..43006aceb107 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_AssessPatches.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "rebootPending": true, + "criticalAndSecurityPatchCount": 1, + "otherPatchCount": 2, + "startDateTime": "2020-04-24T21:02:04.2556154Z", + "availablePatches": [ + { + "patchId": "35428702-5784-4ba4-a6e0-5222258b5411", + "name": "Definition Update for Windows Defender Antivirus - KB2267602 (Definition 1.279.1373.0)", + "version": "", + "kbId": "2267602", + "classifications": [ + "Definition Updates" + ], + "rebootBehavior": "NeverReboots", + "activityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "publishedDate": "2018-11-07T00:00:00Z", + "lastModifiedDateTime": "2020-04-24T21:18:45.2830263Z", + "assessmentState": "Available" + }, + { + "patchId": "39f9cdd1-795c-4d0e-8c0a-73ab3f31746d", + "name": "Windows Malicious Software Removal Tool x64 - October 2018 (KB890830)", + "version": "", + "kbId": "890830", + "classifications": [ + "Update Rollups" + ], + "rebootBehavior": "CanRequestReboot", + "activityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "publishedDate": "2018-11-07T00:00:00Z", + "lastModifiedDateTime": "2020-04-24T21:18:45.2830263Z", + "assessmentState": "Available" + } + ], + "error": null + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c5577b8d7c9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}", + "parameters": { + "dataDisksToAttach": [ + { + "lun": 1, + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d" + }, + { + "lun": 2, + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e" + } + ], + "dataDisksToDetach": [ + { + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x", + "detachOption": "ForceDetach" + }, + { + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z", + "detachOption": "ForceDetach" + } + ] + } + }, + "responses": { + "200": { + "body": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [ + { + "lun": 1, + "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d" + }, + "diskSizeGB": 30 + }, + { + "lun": 2, + "name": "vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e" + }, + "diskSizeGB": 100 + } + ] + }, + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json new file mode 100644 index 000000000000..159eed95a265 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "azure-vm", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}", + "parameters": { + "dataDisksToAttach": [ + { + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d" + } + ], + "dataDisksToDetach": [ + { + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x" + } + ] + } + }, + "responses": { + "200": { + "body": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [ + { + "lun": 0, + "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d" + }, + "diskSizeGB": 30 + } + ] + }, + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Capture_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Capture_MaximumSet_Gen.json new file mode 100644 index 000000000000..d169f2bc484f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Capture_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaaaaaa", + "parameters": { + "vhdPrefix": "aaaaaaaaa", + "destinationContainerName": "aaaaaaa", + "overwriteVhds": true + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "$schema": "aaaaa", + "contentVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "parameters": {}, + "resources": [ + {} + ], + "id": "aaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Capture_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Capture_MinimumSet_Gen.json new file mode 100644 index 000000000000..5cab319251d2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Capture_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaa", + "parameters": { + "vhdPrefix": "aaaaaaaaa", + "destinationContainerName": "aaaaaaa", + "overwriteVhds": true + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": {} + }, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ConvertToManagedDisks_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ConvertToManagedDisks_MaximumSet_Gen.json new file mode 100644 index 000000000000..a9562fbc71f3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ConvertToManagedDisks_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ConvertToManagedDisks_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ConvertToManagedDisks_MinimumSet_Gen.json new file mode 100644 index 000000000000..ff0be5dd8e3e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ConvertToManagedDisks_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_CustomImageVmFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_CustomImageVmFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..cce2dea2ee12 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_CustomImageVmFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "osType": "Windows", + "createOption": "FromImage", + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + } + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACommunityGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACommunityGalleryImage.json new file mode 100644 index 000000000000..311721e4513c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACommunityGalleryImage.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "communityGalleryImageId": "/CommunityGalleries/galleryPublicName/Images/communityGalleryImageName/Versions/communityGalleryImageVersionName" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "communityGalleryImageId": "/CommunityGalleries/galleryPublicName/Images/communityGalleryImageName/Versions/communityGalleryImageVersionName" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "communityGalleryImageId": "/CommunityGalleries/galleryPublicName/Images/communityGalleryImageName/Versions/communityGalleryImageVersionName" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACustomImage.json new file mode 100644 index 000000000000..75db76ff910c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromACustomImage.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromAGeneralizedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromAGeneralizedSharedImage.json new file mode 100644 index 000000000000..113e845cca5f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromAGeneralizedSharedImage.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASharedGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASharedGalleryImage.json new file mode 100644 index 000000000000..aa32ef0999fc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASharedGalleryImage.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sharedGalleryImageId": "/SharedGalleries/sharedGalleryName/Images/sharedGalleryImageName/Versions/sharedGalleryImageVersionName" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sharedGalleryImageId": "/SharedGalleries/sharedGalleryName/Images/sharedGalleryImageName/Versions/sharedGalleryImageVersionName" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sharedGalleryImageId": "/SharedGalleries/sharedGalleryName/Images/sharedGalleryImageName/Versions/sharedGalleryImageVersionName" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASpecializedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASpecializedSharedImage.json new file mode 100644 index 000000000000..8a9af289f137 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_FromASpecializedSharedImage.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_InAVmssWithCustomerAssignedPlatformFaultDomain.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_InAVmssWithCustomerAssignedPlatformFaultDomain.json new file mode 100644 index 000000000000..35ccacf1f23e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_InAVmssWithCustomerAssignedPlatformFaultDomain.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "virtualMachineScaleSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{existing-flex-vmss-name-with-platformFaultDomainCount-greater-than-1}" + }, + "platformFaultDomain": 1 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "7cce54f2-ecd3-4ddd-a8d9-50984faa3918", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "virtualMachineScaleSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myExistingFlexVmss" + }, + "platformFaultDomain": 1, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "7cce54f2-ecd3-4ddd-a8d9-50984faa3918", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "virtualMachineScaleSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myExistingFlexVmss" + }, + "platformFaultDomain": 1, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_InAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_InAnAvailabilitySet.json new file mode 100644 index 000000000000..ec9fad9fd7ec --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_InAnAvailabilitySet.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithAutomaticByPlatformSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithAutomaticByPlatformSettings.json new file mode 100644 index 000000000000..bc79c81c77b9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithAutomaticByPlatformSettings.json @@ -0,0 +1,178 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform", + "automaticByPlatformSettings": { + "rebootSetting": "Never", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform", + "automaticByPlatformSettings": { + "rebootSetting": "Never", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform", + "automaticByPlatformSettings": { + "rebootSetting": "Never", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingAssessmentModeOfImageDefault.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingAssessmentModeOfImageDefault.json new file mode 100644 index 000000000000..eacf14fb39a1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingAssessmentModeOfImageDefault.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "assessmentMode": "ImageDefault" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "assessmentMode": "ImageDefault" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "assessmentMode": "ImageDefault" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModeOfImageDefault.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModeOfImageDefault.json new file mode 100644 index 000000000000..2febeb1acb08 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModeOfImageDefault.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModesOfAutomaticByPlatform.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModesOfAutomaticByPlatform.json new file mode 100644 index 000000000000..53499d765fb8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModesOfAutomaticByPlatform.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_PlatformImageVmWithUnmanagedOsAndDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_PlatformImageVmWithUnmanagedOsAndDataDisks.json new file mode 100644 index 000000000000..8e8051f74cd0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_PlatformImageVmWithUnmanagedOsAndDataDisks.json @@ -0,0 +1,213 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd" + } + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd" + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithAutomaticByPlatformSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithAutomaticByPlatformSettings.json new file mode 100644 index 000000000000..b088b767c2e9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithAutomaticByPlatformSettings.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform", + "automaticByPlatformSettings": { + "rebootSetting": "Never", + "bypassPlatformSafetyChecksOnUserSchedule": false + } + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform", + "automaticByPlatformSettings": { + "rebootSetting": "Never", + "bypassPlatformSafetyChecksOnUserSchedule": false + } + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform", + "automaticByPlatformSettings": { + "rebootSetting": "Never", + "bypassPlatformSafetyChecksOnUserSchedule": false + } + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingAssessmentModeOfImageDefault.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingAssessmentModeOfImageDefault.json new file mode 100644 index 000000000000..ed8d7967b8d7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingAssessmentModeOfImageDefault.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "assessmentMode": "ImageDefault" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "assessmentMode": "ImageDefault" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": false, + "patchSettings": { + "assessmentMode": "ImageDefault" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByOS.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByOS.json new file mode 100644 index 000000000000..dfc18438507e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByOS.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByOS" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByOS" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByOS" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json new file mode 100644 index 000000000000..6fae3d70838f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "enableHotpatching": true + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "enableHotpatching": true + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "enableHotpatching": true + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfManual.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfManual.json new file mode 100644 index 000000000000..98b0747ffaf1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfManual.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "Manual" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "Manual" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": false, + "patchSettings": { + "patchMode": "Manual" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModesOfAutomaticByPlatform.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModesOfAutomaticByPlatform.json new file mode 100644 index 000000000000..162f76453bd0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModesOfAutomaticByPlatform.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "assessmentMode": "AutomaticByPlatform" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDisk.json new file mode 100644 index 000000000000..eff930479cef --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDisk.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json new file mode 100644 index 000000000000..c762bda28ce0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json new file mode 100644 index 000000000000..14b09f744496 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..67bfb3e0117a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithAMarketplaceImagePlan.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithApplicationProfile.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithApplicationProfile.json new file mode 100644 index 000000000000..4682d05345f2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithApplicationProfile.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "{image_sku}", + "publisher": "{image_publisher}", + "version": "latest", + "offer": "{image_offer}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config", + "treatFailureAsDeploymentFailure": false, + "enableAutomaticUpgrade": false + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config" + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config" + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithBootDiagnostics.json new file mode 100644 index 000000000000..5ca3d90dfd3e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithBootDiagnostics.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithCapacityReservation.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithCapacityReservation.json new file mode 100644 index 000000000000..f9eb70f0ee67 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithCapacityReservation.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskControllerType.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskControllerType.json new file mode 100644 index 000000000000..d16f794343d7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskControllerType.json @@ -0,0 +1,175 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D4_v3" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "diskControllerType": "NVMe" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "userData": "U29tZSBDdXN0b20gRGF0YQ==" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [], + "diskControllerType": "NVMe" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D4_v3" + }, + "provisioningState": "Updating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [], + "diskControllerType": "NVMe" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D4_v3" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskEncryptionSetResource.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskEncryptionSetResource.json new file mode 100644 index 000000000000..52bc88856372 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithDiskEncryptionSetResource.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "caching": "ReadWrite", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}", + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Attach", + "lun": 1 + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskencryptionset-name}" + } + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "caching": "ReadWrite", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}", + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Attach", + "lun": 1 + } + ] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "caching": "ReadWrite", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}", + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Attach", + "lun": 1 + } + ] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEmptyDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEmptyDataDisks.json new file mode 100644 index 000000000000..3ad587de00cf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEmptyDataDisks.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023, + "toBeDetached": false + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023, + "toBeDetached": false + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionAtHost.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionAtHost.json new file mode 100644 index 000000000000..1ea85136ff98 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionAtHost.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "securityProfile": { + "encryptionAtHost": true + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "encryptionAtHost": true + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "encryptionAtHost": true + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionIdentity.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionIdentity.json new file mode 100644 index 000000000000..0f752fc646d0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionIdentity.json @@ -0,0 +1,186 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {} + } + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "securityProfile": { + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {} + } + }, + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + } + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity": {} + } + }, + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + } + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithExtensionsTimeBudget.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithExtensionsTimeBudget.json new file mode 100644 index 000000000000..3ec9c68bd18b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithExtensionsTimeBudget.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "extensionsTimeBudget": "PT30M" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "extensionsTimeBudget": "PT30M", + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "extensionsTimeBudget": "PT30M", + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithHibernationEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithHibernationEnabled.json new file mode 100644 index 000000000000..31a2cc3f481b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithHibernationEnabled.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2023-09-01", + "parameters": { + "location": "eastus2euap", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "additionalCapabilities": { + "hibernationEnabled": true + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "vmOSdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "{vm-name}", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "{vm-name}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "vmOSdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "additionalCapabilities": { + "hibernationEnabled": true + }, + "provisioningState": "Updating" + }, + "name": "{vm-name}", + "location": "eastus2euap" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "{vm-name}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "vmOSdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "additionalCapabilities": { + "hibernationEnabled": true + }, + "provisioningState": "Creating" + }, + "name": "{vm-name}", + "location": "eastus2euap" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithManagedBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithManagedBootDiagnostics.json new file mode 100644 index 000000000000..2ef17c92cd0f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithManagedBootDiagnostics.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfiguration.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfiguration.json new file mode 100644 index 000000000000..73915929011e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfiguration.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkApiVersion": "2020-11-01", + "networkInterfaceConfigurations": [ + { + "name": "{nic-config-name}", + "properties": { + "primary": true, + "deleteOption": "Delete", + "ipConfigurations": [ + { + "name": "{ip-config-name}", + "properties": { + "primary": true, + "publicIPAddressConfiguration": { + "name": "{publicIP-config-name}", + "sku": { + "name": "Basic", + "tier": "Global" + }, + "properties": { + "deleteOption": "Detach", + "publicIPAllocationMethod": "Static" + } + } + } + } + ] + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/toBeCreatedNetworkInterface", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/toBeCreatedNetworkInterface", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfigurationDnsSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfigurationDnsSettings.json new file mode 100644 index 000000000000..7976349c7f86 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfigurationDnsSettings.json @@ -0,0 +1,178 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkApiVersion": "2020-11-01", + "networkInterfaceConfigurations": [ + { + "name": "{nic-config-name}", + "properties": { + "primary": true, + "deleteOption": "Delete", + "ipConfigurations": [ + { + "name": "{ip-config-name}", + "properties": { + "primary": true, + "publicIPAddressConfiguration": { + "name": "{publicIP-config-name}", + "sku": { + "name": "Basic", + "tier": "Global" + }, + "properties": { + "deleteOption": "Detach", + "publicIPAllocationMethod": "Static", + "dnsSettings": { + "domainNameLabel": "aaaaa", + "domainNameLabelScope": "TenantReuse" + } + } + } + } + } + ] + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/toBeCreatedNetworkInterface", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/toBeCreatedNetworkInterface", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPasswordAuthentication.json new file mode 100644 index 000000000000..fc125fb56ab3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPasswordAuthentication.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPremiumStorage.json new file mode 100644 index 000000000000..d11dd6b49b56 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithPremiumStorage.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithProxyAgentSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithProxyAgentSettings.json new file mode 100644 index 000000000000..29ef3d33de3d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithProxyAgentSettings.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "securityProfile": { + "proxyAgentSettings": { + "enabled": true, + "mode": "Enforce" + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "proxyAgentSettings": { + "enabled": true, + "mode": "Enforce" + } + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "proxyAgentSettings": { + "enabled": true, + "mode": "Enforce" + } + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithScheduledEventsProfile.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithScheduledEventsProfile.json new file mode 100644 index 000000000000..857f862027a5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithScheduledEventsProfile.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "PT10M", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "PT15M", + "enable": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "PT10M", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "PT15M", + "enable": true + } + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "PT10M", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "PT15M", + "enable": true + } + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVM.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVM.json new file mode 100644 index 000000000000..9bb32f87ff1c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVM.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DC2as_v5" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "storageProfile": { + "imageReference": { + "sku": "windows-cvm", + "publisher": "MicrosoftWindowsServer", + "version": "17763.2183.2109130127", + "offer": "2019-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "DiskWithVMGuestState" + } + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "windows-cvm", + "publisher": "MicrosoftWindowsServer", + "version": "17763.2183.2109130127", + "offer": "2019-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "DiskWithVMGuestState" + } + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DC2as_v5" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "windows-cvm", + "publisher": "MicrosoftWindowsServer", + "version": "17763.2183.2109130127", + "offer": "2019-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "DiskWithVMGuestState" + } + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DC2as_v5" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithCustomerManagedKeys.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithCustomerManagedKeys.json new file mode 100644 index 000000000000..4f3f3b2bc4f6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithCustomerManagedKeys.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DC2as_v5" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "storageProfile": { + "imageReference": { + "sku": "windows-cvm", + "publisher": "MicrosoftWindowsServer", + "version": "17763.2183.2109130127", + "offer": "2019-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "DiskWithVMGuestState", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + } + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "windows-cvm", + "publisher": "MicrosoftWindowsServer", + "version": "17763.2183.2109130127", + "offer": "2019-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "DiskWithVMGuestState", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + } + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DC2as_v5" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "windows-cvm", + "publisher": "MicrosoftWindowsServer", + "version": "17763.2183.2109130127", + "offer": "2019-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "DiskWithVMGuestState", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + } + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DC2as_v5" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json new file mode 100644 index 000000000000..14341d299bd6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DC2es_v5" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": false, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "storageProfile": { + "imageReference": { + "sku": "linux-cvm", + "publisher": "UbuntuServer", + "version": "17763.2183.2109130127", + "offer": "2022-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "linux-cvm", + "publisher": "UbuntuServer", + "version": "17763.2183.2109130127", + "offer": "2022-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": false, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DC2es_v5" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "linux-cvm", + "publisher": "UbuntuServer", + "version": "17763.2183.2109130127", + "offer": "2022-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": false, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DC2es_v5" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSshAuthentication.json new file mode 100644 index 000000000000..f748e528d670 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithSshAuthentication.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "{image_sku}", + "publisher": "{image_publisher}", + "version": "latest", + "offer": "{image_offer}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUefiSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUefiSettings.json new file mode 100644 index 000000000000..ed6afd278da7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUefiSettings.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "TrustedLaunch" + }, + "storageProfile": { + "imageReference": { + "sku": "windows10-tvm", + "publisher": "MicrosoftWindowsServer", + "version": "18363.592.2001092016", + "offer": "windowsserver-gen2preview-preview" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "windows10-tvm", + "publisher": "MicrosoftWindowsServer", + "version": "18363.592.2001092016", + "offer": "windowsserver-gen2preview-preview" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "TrustedLaunch" + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "windows10-tvm", + "publisher": "MicrosoftWindowsServer", + "version": "18363.592.2001092016", + "offer": "windowsserver-gen2preview-preview" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "TrustedLaunch" + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUserData.json new file mode 100644 index 000000000000..90c1b17280e6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithUserData.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "vmOSdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "{vm-name}", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "{vm-name}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "vmOSdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "{vm-name}", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/{vm-name}", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "{vm-name}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "vmOSdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "{vm-name}", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithVMSizeProperties.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithVMSizeProperties.json new file mode 100644 index 000000000000..f5e5a31275cb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Create_WithVMSizeProperties.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D4_v3", + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "userData": "U29tZSBDdXN0b20gRGF0YQ==" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D4_v3", + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "provisioningState": "Updating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D4_v3", + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Deallocate_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Deallocate_MaximumSet_Gen.json new file mode 100644 index 000000000000..0a8719e3b3cf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Deallocate_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaa", + "hibernate": true, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Deallocate_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Deallocate_MinimumSet_Gen.json new file mode 100644 index 000000000000..87e01fb1cec5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Deallocate_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Delete_Force.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Delete_Force.json new file mode 100644 index 000000000000..ba9f0b1e8a3d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Delete_Force.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "forceDeletion": "true", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Generalize.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Generalize.json new file mode 100644 index 000000000000..4e7efcb6a3ca --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Generalize.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "vmName": "myVMName" + }, + "responses": { + "200": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get.json new file mode 100644 index 000000000000..093168579a64 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "$expand": "userData" + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "location": "West US", + "tags": { + "myTag1": "tagValue1" + }, + "etag": "\"1\"", + "properties": { + "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1", + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet" + }, + "proximityPlacementGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/my-ppg01" + }, + "hardwareProfile": { + "vmSize": "Standard_DS3_v2" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [ + { + "lun": 0, + "name": "myDataDisk0", + "createOption": "Empty", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0" + }, + "diskSizeGB": 30 + }, + { + "lun": 1, + "name": "myDataDisk1", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1" + }, + "diskSizeGB": 100 + } + ] + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config" + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "osProfile": { + "computerName": "myVM", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": false + }, + "secrets": [] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}" + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://{myStorageAccount}.blob.core.windows.net" + } + }, + "extensionsTimeBudget": "PT50M", + "provisioningState": "Succeeded", + "timeCreated": "2021-06-27T01:02:38.3138469+00:00" + }, + "resources": [ + { + "name": "CustomScriptExtension-DSC", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC", + "type": "Microsoft.Compute/virtualMachines/extensions", + "location": "west us", + "tags": { + "displayName": "CustomScriptExtension-DSC" + }, + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.9", + "settings": {} + } + } + ], + "managedBy": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{MyVmss}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..1027900039b6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "location": "West US", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1", + "hostGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup" + }, + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "myVM", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": false + }, + "secrets": [] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}" + } + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json new file mode 100644 index 000000000000..5125ae212386 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "vmName": "myVM" + }, + "responses": { + "200": { + "body": { + "platformUpdateDomain": 1, + "platformFaultDomain": 1, + "computerName": "myVM", + "osName": "Windows Server 2016 Datacenter", + "osVersion": "Microsoft Windows NT 10.0.14393.0", + "vmAgent": { + "vmAgentVersion": "2.7.41491.949", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Ready", + "message": "GuestAgent is running and accepting new configurations.", + "time": "2019-10-14T23:11:22+00:00" + } + ], + "extensionHandlers": [ + { + "type": "Microsoft.Azure.Security.IaaSAntimalware", + "typeHandlerVersion": "1.5.5.9", + "status": { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Ready" + } + } + ] + }, + "disks": [ + { + "name": "myOsDisk", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2019-10-14T21:29:47.477089+00:00" + } + ] + }, + { + "name": "myDataDisk0", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2019-10-14T21:29:47.461517+00:00" + } + ] + } + ], + "bootDiagnostics": { + "consoleScreenshotBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.screenshot.bmp", + "serialConsoleLogBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.serialconsole.log" + }, + "extensions": [ + { + "name": "IaaSAntiMalware-ext0", + "type": "Microsoft.Azure.Security.IaaSAntimalware", + "typeHandlerVersion": "1.5.5.9", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Microsoft Antimalware enabled" + } + ] + } + ], + "hyperVGeneration": "V1", + "patchStatus": { + "availablePatchSummary": { + "status": "Succeeded", + "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "rebootPending": true, + "criticalAndSecurityPatchCount": 1, + "otherPatchCount": 2, + "startTime": "2020-04-24T21:02:04.2556154Z", + "lastModifiedTime": "2020-04-24T21:02:04.2556154Z", + "error": null + }, + "lastPatchInstallationSummary": { + "status": "Succeeded", + "installationActivityId": "68f8b292-dfc2-4646-9981-33cc88631968", + "maintenanceWindowExceeded": false, + "notSelectedPatchCount": 1, + "excludedPatchCount": 1, + "pendingPatchCount": 1, + "installedPatchCount": 1, + "failedPatchCount": 1, + "startTime": "2020-04-24T21:02:04.2556154Z", + "lastModifiedTime": "2020-04-24T21:02:04.2556154Z", + "error": null + }, + "configurationStatuses": [ + { + "code": "PatchModeConfigurationState/Ready", + "level": "Info", + "displayStatus": "Status_PatchModeConfigurationState_Ready", + "time": "2020-04-24T21:02:04.2556154Z" + }, + { + "code": "AssessmentModeConfigurationState/Pending", + "level": "Info", + "displayStatus": "Status_AssessmentModeConfigurationState_Pending", + "time": "2020-04-24T21:02:04.2556154Z" + } + ] + }, + "isVMInStandbyPool": false, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2019-10-14T21:30:12.8051917+00:00" + }, + { + "code": "PowerState/running", + "level": "Info", + "displayStatus": "VM running" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..ebfda4a9593c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "vmName": "myVM" + }, + "responses": { + "200": { + "body": { + "computerName": "myVM", + "osName": "Windows Server 2016 Datacenter", + "osVersion": "Microsoft Windows NT 10.0.14393.0", + "vmAgent": { + "vmAgentVersion": "2.7.41491.949", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Ready", + "message": "GuestAgent is running and accepting new configurations.", + "time": "2023-09-01T23:11:22+00:00" + } + ] + }, + "disks": [ + { + "name": "myOsDisk", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2023-09-01T21:29:47.477089+00:00" + } + ] + } + ], + "hyperVGeneration": "V1", + "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2023-09-01T21:30:12.8051917+00:00" + }, + { + "code": "PowerState/running", + "level": "Info", + "displayStatus": "VM running" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json new file mode 100644 index 000000000000..38edf2230d35 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "$expand": "userData" + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "location": "West US", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1", + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet" + }, + "hardwareProfile": { + "vmSize": "Standard_DS3_v2", + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [ + { + "lun": 0, + "name": "myDataDisk0", + "createOption": "Empty", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0" + }, + "diskSizeGB": 30 + }, + { + "lun": 1, + "name": "myDataDisk1", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1" + }, + "diskSizeGB": 100 + } + ], + "diskControllerType": "NVMe" + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config" + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "osProfile": { + "computerName": "myVM", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": false + }, + "secrets": [] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}" + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://{myStorageAccount}.blob.core.windows.net" + } + }, + "extensionsTimeBudget": "PT50M", + "provisioningState": "Succeeded" + }, + "resources": [ + { + "name": "CustomScriptExtension-DSC", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC", + "type": "Microsoft.Compute/virtualMachines/extensions", + "location": "west us", + "tags": { + "displayName": "CustomScriptExtension-DSC" + }, + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.9", + "settings": {} + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json new file mode 100644 index 000000000000..e3ec887aca45 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "expand": "UserData" + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "location": "West US", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1", + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet" + }, + "hardwareProfile": { + "vmSize": "Standard_DS3_v2", + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [ + { + "lun": 0, + "name": "myDataDisk0", + "createOption": "Empty", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0" + }, + "diskSizeGB": 30 + }, + { + "lun": 1, + "name": "myDataDisk1", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1" + }, + "diskSizeGB": 100 + } + ] + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config" + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "osProfile": { + "computerName": "myVM", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": false + }, + "secrets": [] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}" + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://{myStorageAccount}.blob.core.windows.net" + } + }, + "extensionsTimeBudget": "PT50M", + "provisioningState": "Succeeded" + }, + "resources": [ + { + "name": "CustomScriptExtension-DSC", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC", + "type": "Microsoft.Compute/virtualMachines/extensions", + "location": "west us", + "tags": { + "displayName": "CustomScriptExtension-DSC" + }, + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.9", + "settings": {} + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_InstallPatches.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_InstallPatches.json new file mode 100644 index 000000000000..b126db050b60 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_InstallPatches.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2023-09-01", + "installPatchesInput": { + "maximumDuration": "PT4H", + "rebootSetting": "IfRequired", + "windowsParameters": { + "classificationsToInclude": [ + "Critical", + "Security" + ], + "maxPatchPublishDate": "2020-11-19T02:36:43.0539904+00:00" + } + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "installationActivityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "rebootStatus": "Completed", + "maintenanceWindowExceeded": false, + "excludedPatchCount": 0, + "notSelectedPatchCount": 0, + "pendingPatchCount": 2, + "installedPatchCount": 3, + "failedPatchCount": 0, + "startDateTime": "2020-04-24T21:02:04.2556154Z", + "patches": [ + { + "patchId": "35428702-5784-4ba4-a6e0-5222258b5411", + "name": "Definition Update for Windows Defender Antivirus - KB2267602 (Definition 1.279.1373.0)", + "version": "", + "kbId": "2267602", + "classifications": [ + "Definition Updates" + ], + "installationState": "Installed" + }, + { + "patchId": "39f9cdd1-795c-4d0e-8c0a-73ab3f31746d", + "name": "Windows Malicious Software Removal Tool x64 - October 2018 (KB890830)", + "version": "", + "kbId": "890830", + "classifications": [ + "Update Rollups" + ], + "installationState": "Pending" + } + ], + "error": null + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListAll_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListAll_MaximumSet_Gen.json new file mode 100644 index 000000000000..46ef63cd3cc0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListAll_MaximumSet_Gen.json @@ -0,0 +1,693 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}", + "statusOnly": "aaaaaa", + "$filter": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vmId": "{vmId}", + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hardwareProfile": { + "vmSize": "Standard_A0", + "vmSizeProperties": { + "vCPUsAvailable": 7, + "vCPUsPerCore": 14 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20170406", + "exactVersion": "aaaaaaaaaaaaa", + "sharedGalleryImageId": "aaaaaaaaaaaaaaa", + "communityGalleryImageId": "aaaa", + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "osDisk": { + "osType": "Windows", + "name": "test", + "createOption": "FromImage", + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "caching": "None", + "diskSizeGB": 127, + "encryptionSettings": { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f" + }, + "deleteOption": "Delete" + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "Test", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "secrets": [], + "allowExtensionOperations": true, + "customData": "aaaa", + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaaaaaaaaaaaaaaaaaaaaa", + "keyData": "aaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + }, + "requireGuestProvisionSignal": true + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", + "properties": { + "primary": true, + "deleteOption": "Delete" + } + } + ], + "networkApiVersion": "2022-05-01", + "networkInterfaceConfigurations": [ + { + "name": "aaaaaaaa", + "properties": { + "primary": true, + "deleteOption": "Delete", + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "enableIPForwarding": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "dnsSettings": { + "dnsServers": [ + "aaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "ipConfigurations": [ + { + "name": "aaaaaaaa", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 23, + "deleteOption": "Delete", + "dnsSettings": { + "domainNameLabel": "aaaaa", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "aaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "dscpConfiguration": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaaaaaaaaaa" + } + }, + "virtualMachineScaleSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "priority": "Regular", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": 26 + }, + "host": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hostGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "licenseType": "aaaaaaaaaaaaaaa", + "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "platformFaultDomain": 8, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "PT10M", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "PT15M", + "enable": true + } + }, + "userData": "aaa", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "aaaaa", + "order": 4, + "packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa", + "configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + }, + "timeCreated": "2022-01-14T16:43:41.683Z" + }, + "type": "Microsoft.Compute/virtualMachines", + "location": "eastus", + "tags": {}, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}", + "name": "{virtualMachineName}", + "plan": { + "name": "aaaaaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaa" + }, + "resources": [ + { + "properties": { + "forceUpdateTag": "aaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaa", + "type": "aaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaa", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisioningState": "aaa", + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "sourceVault": { + "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName" + }, + "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e" + } + }, + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaaaaa", + "tags": { + "key9428": "aaaaaaa" + } + } + ], + "identity": { + "principalId": "aaaaaaaaaaaaaaaa", + "tenantId": "aaaaa", + "type": "SystemAssigned", + "userAssignedIdentities": { + "key5688": { + "principalId": "aaaaaaaaaaaaaaa", + "clientId": "aaaaaaaaaaa" + } + } + }, + "zones": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "extendedLocation": { + "name": "aaaa", + "type": "EdgeZone" + } + }, + { + "properties": { + "vmId": "{vmId}", + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hardwareProfile": { + "vmSize": "Standard_A0", + "vmSizeProperties": { + "vCPUsAvailable": 7, + "vCPUsPerCore": 14 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20170406", + "exactVersion": "aa", + "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "communityGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaa" + }, + "osDisk": { + "osType": "Windows", + "name": "test", + "createOption": "FromImage", + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "caching": "None", + "diskSizeGB": 127, + "encryptionSettings": { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f" + }, + "deleteOption": "Delete" + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "Test", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "secrets": [], + "allowExtensionOperations": true, + "customData": "aaaaaaaaaaaaaaaaaaaaaaa", + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaaaaaaaaaaaaaaaaaaaaa", + "keyData": "aaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + }, + "requireGuestProvisionSignal": true + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", + "properties": { + "primary": true, + "deleteOption": "Delete" + } + } + ], + "networkApiVersion": "2022-05-01", + "networkInterfaceConfigurations": [ + { + "name": "aaaaaaaa", + "properties": { + "primary": true, + "deleteOption": "Delete", + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "enableIPForwarding": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "dnsSettings": { + "dnsServers": [ + "aaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "ipConfigurations": [ + { + "name": "aaaaaaaa", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 23, + "deleteOption": "Delete", + "dnsSettings": { + "domainNameLabel": "aaaaa", + "domainNameLabelScope": "SubscriptionReuse" + }, + "ipTags": [ + { + "ipTagType": "aaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "dscpConfiguration": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaaaaaaaaaa" + } + }, + "virtualMachineScaleSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "priority": "Regular", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": 26 + }, + "host": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hostGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "licenseType": "aaaaaaaaaaaaaa", + "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaa", + "platformFaultDomain": 11, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "PT10M", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "PT15M", + "enable": true + } + }, + "userData": "aaaaaaaaaaaaaaaaaaa", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "aaaaa", + "order": 4, + "packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa", + "configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + }, + "timeCreated": "2022-01-14T16:43:41.685Z" + }, + "type": "Microsoft.Compute/virtualMachines", + "location": "eastus", + "tags": {}, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}", + "name": "{virtualMachineName}", + "plan": { + "name": "aaaaaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaa" + }, + "resources": [ + { + "properties": { + "forceUpdateTag": "aaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaa", + "type": "aaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaa", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisioningState": "aaa", + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "sourceVault": { + "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName" + }, + "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e" + } + }, + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaaaaa", + "tags": { + "key9428": "aaaaaaa" + } + } + ], + "identity": { + "principalId": "aaaaaaaaaaaaaaaa", + "tenantId": "aaaaa", + "type": "SystemAssigned", + "userAssignedIdentities": { + "key5688": { + "principalId": "aaaaaaaaaaaaaaa", + "clientId": "aaaaaaaaaaa" + } + } + }, + "zones": [ + "aaaaaa" + ], + "extendedLocation": { + "name": "aaaa", + "type": "EdgeZone" + } + } + ], + "nextLink": "a" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListAll_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListAll_MinimumSet_Gen.json new file mode 100644 index 000000000000..79a9e292514c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListAll_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}" + }, + { + "location": "eastus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListAvailableVmSizes.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListAvailableVmSizes.json new file mode 100644 index 000000000000..75d66fe4c282 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListAvailableVmSizes.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVmName", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_A1_V2", + "numberOfCores": 1, + "osDiskSizeInMB": 1047552, + "resourceDiskSizeInMB": 10240, + "memoryInMB": 2048, + "maxDataDiskCount": 2 + }, + { + "name": "Standard_A2_V2", + "numberOfCores": 2, + "osDiskSizeInMB": 1047552, + "resourceDiskSizeInMB": 20480, + "memoryInMB": 4096, + "maxDataDiskCount": 4 + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListBySubscription_ByLocation.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListBySubscription_ByLocation.json new file mode 100644 index 000000000000..19a4c4a34cc1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_ListBySubscription_ByLocation.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "location": "eastus", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vmId": "{vmId}", + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hardwareProfile": { + "vmSize": "Standard_A0" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20170406" + }, + "osDisk": { + "osType": "Windows", + "name": "test", + "createOption": "FromImage", + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "caching": "None", + "diskSizeGB": 127 + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "Test", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}" + } + ] + }, + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/virtualMachines", + "location": "eastus", + "tags": { + "RG": "rg", + "testTag": "1" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}", + "name": "{virtualMachineName}" + }, + { + "properties": { + "vmId": "{vmId}", + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hardwareProfile": { + "vmSize": "Standard_A0" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20170406" + }, + "osDisk": { + "osType": "Windows", + "name": "test", + "createOption": "FromImage", + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "caching": "None", + "diskSizeGB": 127 + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "Test", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}" + } + ] + }, + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/virtualMachines", + "location": "eastus", + "tags": { + "RG": "rg", + "testTag": "1" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}", + "name": "{virtualMachineName}" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..827a5ce1533a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_List_MaximumSet_Gen.json @@ -0,0 +1,931 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "$filter": "aaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vmId": "{vmId}", + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hardwareProfile": { + "vmSize": "Standard_A0", + "vmSizeProperties": { + "vCPUsAvailable": 7, + "vCPUsPerCore": 14 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20170406", + "exactVersion": "aaaaaaaaaaaaa", + "sharedGalleryImageId": "aaaaaaaaaaaaaaa", + "communityGalleryImageId": "aaaa", + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "osDisk": { + "osType": "Windows", + "name": "test", + "createOption": "FromImage", + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "caching": "None", + "diskSizeGB": 127, + "encryptionSettings": { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f" + }, + "deleteOption": "Delete" + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "Test", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "secrets": [], + "allowExtensionOperations": true, + "customData": "aaaa", + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaaaaaaaaaaaaaaaaaaaaa", + "keyData": "aaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + }, + "requireGuestProvisionSignal": true + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", + "properties": { + "primary": true, + "deleteOption": "Delete" + } + } + ], + "networkApiVersion": "2022-05-01", + "networkInterfaceConfigurations": [ + { + "name": "aaaaaaaa", + "properties": { + "primary": true, + "deleteOption": "Delete", + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "enableIPForwarding": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "dnsSettings": { + "dnsServers": [ + "aaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "ipConfigurations": [ + { + "name": "aaaaaaaa", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 23, + "deleteOption": "Delete", + "dnsSettings": { + "domainNameLabel": "aaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "dscpConfiguration": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaaaaaaaaaa" + } + }, + "virtualMachineScaleSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "priority": "Regular", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": 26 + }, + "host": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hostGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "licenseType": "aaaaaaaaaaaaaaa", + "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "platformFaultDomain": 8, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "PT10M", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "PT15M", + "enable": true + } + }, + "userData": "aaa", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "aaaaa", + "order": 4, + "packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa", + "configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + }, + "timeCreated": "2022-01-14T16:43:41.683Z" + }, + "type": "Microsoft.Compute/virtualMachines", + "location": "eastus", + "tags": {}, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}", + "name": "{virtualMachineName}", + "plan": { + "name": "aaaaaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaa" + }, + "resources": [ + { + "properties": { + "forceUpdateTag": "aaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaa", + "type": "aaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaa", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisioningState": "aaa", + "instanceView": { + "name": "aaaaaaaaaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaa", + "typeHandlerVersion": "aaaaaa", + "substatuses": [ + { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + ], + "statuses": [ + { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + ] + }, + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "sourceVault": { + "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName" + }, + "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e" + } + }, + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaaaaa", + "tags": { + "key9428": "aaaaaaa" + } + } + ], + "identity": { + "principalId": "aaaaaaaaaaaaaaaa", + "tenantId": "aaaaa", + "type": "SystemAssigned", + "userAssignedIdentities": { + "key5688": { + "principalId": "aaaaaaaaaaaaaaa", + "clientId": "aaaaaaaaaaa" + } + } + }, + "zones": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + ], + "extendedLocation": { + "name": "aaaa", + "type": "EdgeZone" + } + }, + { + "properties": { + "vmId": "{vmId}", + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hardwareProfile": { + "vmSize": "Standard_A0", + "vmSizeProperties": { + "vCPUsAvailable": 7, + "vCPUsPerCore": 14 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20170406", + "exactVersion": "aa", + "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "communityGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaa" + }, + "osDisk": { + "osType": "Windows", + "name": "test", + "createOption": "FromImage", + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "caching": "None", + "diskSizeGB": 127, + "encryptionSettings": { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f" + }, + "deleteOption": "Delete" + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "Test", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "secrets": [], + "allowExtensionOperations": true, + "customData": "aaaaaaaaaaaaaaaaaaaaaaa", + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaaaaaaaaaaaaaaaaaaaaa", + "keyData": "aaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + }, + "requireGuestProvisionSignal": true + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}", + "properties": { + "primary": true, + "deleteOption": "Delete" + } + } + ], + "networkApiVersion": "2022-05-01", + "networkInterfaceConfigurations": [ + { + "name": "aaaaaaaa", + "properties": { + "primary": true, + "deleteOption": "Delete", + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "enableIPForwarding": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "dnsSettings": { + "dnsServers": [ + "aaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "ipConfigurations": [ + { + "name": "aaaaaaaa", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 23, + "deleteOption": "Delete", + "dnsSettings": { + "domainNameLabel": "aaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "dscpConfiguration": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaaaaaaaaaa" + } + }, + "virtualMachineScaleSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "priority": "Regular", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": 26 + }, + "host": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hostGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "instanceView": { + "platformUpdateDomain": 1, + "platformFaultDomain": 29, + "computerName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "osName": "aaaaaaaaaaa", + "osVersion": "aaaaaaaaaaaaaa", + "hyperVGeneration": "V1", + "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaa", + "vmAgent": { + "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "extensionHandlers": [ + { + "type": "aaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaa", + "status": { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + } + ], + "statuses": [ + { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + ] + }, + "maintenanceRedeployStatus": { + "isCustomerInitiatedMaintenanceAllowed": true, + "preMaintenanceWindowStartTime": "2022-01-14T16:43:41.682Z", + "preMaintenanceWindowEndTime": "2022-01-14T16:43:41.682Z", + "maintenanceWindowStartTime": "2022-01-14T16:43:41.682Z", + "maintenanceWindowEndTime": "2022-01-14T16:43:41.682Z", + "lastOperationResultCode": "None", + "lastOperationMessage": "aa" + }, + "disks": [ + { + "name": "a", + "encryptionSettings": [ + { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + } + ], + "statuses": [ + { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + ] + } + ], + "extensions": [ + { + "name": "aaaaaaaaaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaa", + "typeHandlerVersion": "aaaaaa", + "substatuses": [ + { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + ], + "statuses": [ + { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + ] + } + ], + "vmHealth": { + "status": { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + }, + "bootDiagnostics": { + "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaa", + "serialConsoleLogBlobUri": "aaaaaaaaaaaaaaaaaaa", + "status": { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + }, + "assignedHost": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "statuses": [ + { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + ], + "patchStatus": { + "availablePatchSummary": { + "status": "Unknown", + "assessmentActivityId": "aaaaaaaaaaaaaaaaaaa", + "rebootPending": true, + "criticalAndSecurityPatchCount": 22, + "otherPatchCount": 25, + "startTime": "2022-01-14T16:43:41.682Z", + "lastModifiedTime": "2022-01-14T16:43:41.683Z", + "error": { + "details": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaa", + "target": "aaaaaa", + "message": "aaaaaaaaaaaaa" + } + ], + "innererror": { + "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "code": "aaaaaa", + "target": "aaaaaaaaa", + "message": "aaa" + } + }, + "lastPatchInstallationSummary": { + "status": "Unknown", + "installationActivityId": "aaaaaa", + "maintenanceWindowExceeded": true, + "notSelectedPatchCount": 20, + "excludedPatchCount": 1, + "pendingPatchCount": 2, + "installedPatchCount": 28, + "failedPatchCount": 30, + "startTime": "2022-01-14T16:43:41.683Z", + "lastModifiedTime": "2022-01-14T16:43:41.683Z", + "error": { + "details": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaa", + "target": "aaaaaa", + "message": "aaaaaaaaaaaaa" + } + ], + "innererror": { + "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "code": "aaaaaa", + "target": "aaaaaaaaa", + "message": "aaa" + } + }, + "configurationStatuses": [ + { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + ] + }, + "isVMInStandbyPool": false + }, + "licenseType": "aaaaaaaaaaaaaa", + "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaa", + "platformFaultDomain": 11, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "PT10M", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "PT15M", + "enable": true + } + }, + "userData": "aaaaaaaaaaaaaaaaaaa", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "aaaaa", + "order": 4, + "packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa", + "configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + }, + "timeCreated": "2022-01-14T16:43:41.685Z" + }, + "type": "Microsoft.Compute/virtualMachines", + "location": "eastus", + "tags": {}, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}", + "name": "{virtualMachineName}", + "plan": { + "name": "aaaaaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaa" + }, + "resources": [ + { + "properties": { + "forceUpdateTag": "aaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaa", + "type": "aaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaa", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisioningState": "aaa", + "instanceView": { + "name": "aaaaaaaaaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaa", + "typeHandlerVersion": "aaaaaa", + "substatuses": [ + { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + ], + "statuses": [ + { + "code": "aaa", + "level": "Info", + "displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa", + "message": "aaaaaaaaaaaaaaaaaaa", + "time": "2022-01-14T16:43:41.657Z" + } + ] + }, + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "sourceVault": { + "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName" + }, + "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e" + } + }, + "id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaaaaa", + "tags": { + "key9428": "aaaaaaa" + } + } + ], + "identity": { + "principalId": "aaaaaaaaaaaaaaaa", + "tenantId": "aaaaa", + "type": "SystemAssigned", + "userAssignedIdentities": { + "key5688": { + "principalId": "aaaaaaaaaaaaaaa", + "clientId": "aaaaaaaaaaa" + } + } + }, + "zones": [ + "aaaaaa" + ], + "extendedLocation": { + "name": "aaaa", + "type": "EdgeZone" + } + } + ], + "nextLink": "a" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..5d86a0aeffa9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_List_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}" + }, + { + "location": "eastus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PerformMaintenance_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PerformMaintenance_MaximumSet_Gen.json new file mode 100644 index 000000000000..a9562fbc71f3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PerformMaintenance_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PerformMaintenance_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PerformMaintenance_MinimumSet_Gen.json new file mode 100644 index 000000000000..c66049a59451 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PerformMaintenance_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PowerOff_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PowerOff_MaximumSet_Gen.json new file mode 100644 index 000000000000..ff3f1b227fad --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PowerOff_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "skipShutdown": true, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PowerOff_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PowerOff_MinimumSet_Gen.json new file mode 100644 index 000000000000..d145a16deb58 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_PowerOff_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Reapply.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Reapply.json new file mode 100644 index 000000000000..a37428b69c6a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Reapply.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-09-01", + "vmName": "VMName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Redeploy_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Redeploy_MaximumSet_Gen.json new file mode 100644 index 000000000000..1b2f90164a46 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Redeploy_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "a", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Redeploy_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Redeploy_MinimumSet_Gen.json new file mode 100644 index 000000000000..e70a707cd660 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Redeploy_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Reimage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Reimage.json new file mode 100644 index 000000000000..c7a96a6e73ee --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Reimage.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "vmName": "myVMName", + "parameters": { + "tempDisk": true + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json new file mode 100644 index 000000000000..e4bd7b86dd8f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-09-01", + "vmName": "myVMName", + "parameters": { + "tempDisk": true, + "exactVersion": "aaaaaa", + "osProfile": { + "adminPassword": "{your-password}", + "customData": "{your-custom-data}" + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Restart_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Restart_MaximumSet_Gen.json new file mode 100644 index 000000000000..ab133bd647dd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Restart_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Restart_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Restart_MinimumSet_Gen.json new file mode 100644 index 000000000000..8efee63da706 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Restart_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_RetrieveBootDiagnosticsData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_RetrieveBootDiagnosticsData.json new file mode 100644 index 000000000000..ec5808b317c4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_RetrieveBootDiagnosticsData.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-09-01", + "vmName": "VMName", + "sasUriExpirationTimeInMinutes": 60 + }, + "responses": { + "200": { + "body": { + "consoleScreenshotBlobUri": "https://storageuri/vm.screenshot.bmp?{sasKey}", + "serialConsoleLogBlobUri": "https://storageuri/vm.serialconsole.log?{sasKey}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_SimulateEviction.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_SimulateEviction.json new file mode 100644 index 000000000000..441db0f9bc8b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_SimulateEviction.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-09-01", + "vmName": "VMName" + }, + "responses": { + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Start_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Start_MaximumSet_Gen.json new file mode 100644 index 000000000000..ab133bd647dd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Start_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Start_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Start_MinimumSet_Gen.json new file mode 100644 index 000000000000..86f2a70a95bc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Start_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmName": "aaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Update_DetachDataDiskUsingToBeDetachedProperty.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Update_DetachDataDiskUsingToBeDetachedProperty.json new file mode 100644 index 000000000000..e0308d67a3af --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Update_DetachDataDiskUsingToBeDetachedProperty.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "toBeDetached": true + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "toBeDetached": false + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023, + "toBeDetached": true + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023, + "toBeDetached": false + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Updating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Update_ForceDetachDataDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Update_ForceDetachDataDisk.json new file mode 100644 index 000000000000..f97c8cde776d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExamples/VirtualMachine_Update_ForceDetachDataDisk.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2023-09-01", + "parameters": { + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "toBeDetached": true, + "detachOption": "ForceDetach" + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "toBeDetached": false + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023, + "toBeDetached": true, + "detachOption": "ForceDetach" + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023, + "toBeDetached": false + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Updating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d247ac1fe88c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_Get_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaa", + "version": "aaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "properties": { + "operatingSystem": "aaaaaaaaaaaaaaaaaa", + "computeRole": "aaaaaaaaaaaaaaaaa", + "handlerSchema": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmScaleSetEnabled": true, + "supportsMultipleExtensions": true + }, + "id": "aaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaa", + "tags": { + "key9885": "aaaaaaaaa" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..9d1944e6e021 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "aa", + "version": "aaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "name": "aaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListTypes_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListTypes_MaximumSet_Gen.json new file mode 100644 index 000000000000..cd33ddf531f4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListTypes_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "properties": { + "operatingSystem": "aaaaaaaaaaaaaaaaaa", + "computeRole": "aaaaaaaaaaaaaaaaa", + "handlerSchema": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmScaleSetEnabled": true, + "supportsMultipleExtensions": true + }, + "id": "aaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaa", + "tags": { + "key9885": "aaaaaaaaa" + } + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListTypes_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListTypes_MinimumSet_Gen.json new file mode 100644 index 000000000000..6fc89a2341b5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListTypes_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "location": "aaaa", + "publisherName": "aa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListVersions_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListVersions_MaximumSet_Gen.json new file mode 100644 index 000000000000..927a0464b422 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListVersions_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaa", + "$filter": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "$top": 22, + "$orderby": "a", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "properties": { + "operatingSystem": "aaaaaaaaaaaaaaaaaa", + "computeRole": "aaaaaaaaaaaaaaaaa", + "handlerSchema": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmScaleSetEnabled": true, + "supportsMultipleExtensions": true + }, + "id": "aaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaa", + "tags": { + "key9885": "aaaaaaaaa" + } + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListVersions_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListVersions_MinimumSet_Gen.json new file mode 100644 index 000000000000..2f488a94ad81 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListVersions_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "aaaaaaaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "type": "aaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaa", + "id": "aaaaaaaaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..de64b7e3914f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "location": "aaaaaa", + "publisherName": "aaa", + "offer": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "skus": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "version": "aaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "properties": { + "plan": { + "publisher": "aaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaa", + "product": "aaaaaaaaaaaaaa" + }, + "osDiskImage": { + "operatingSystem": "Windows" + }, + "dataDiskImages": [ + { + "lun": 17 + } + ], + "automaticOSUpgradeProperties": { + "automaticOSUpgradeSupported": true + }, + "hyperVGeneration": "V1", + "disallowed": { + "vmDiskType": "None" + }, + "features": [ + { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "value": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "imageDeprecationStatus": { + "imageState": "ScheduledForDeprecation", + "scheduledDeprecationTime": "2023-01-13T00:00:00+00:00", + "alternativeOption": { + "type": "Offer", + "value": "aaaaaaa" + } + } + }, + "name": "aaaaaaaaa", + "location": "aaaaa", + "tags": { + "key6817": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "aaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a9eac8f1fb57 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaa", + "publisherName": "aaaaaaaaaaa", + "offer": "aa", + "skus": "aaaaaaaaa", + "version": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "name": "aaaaaaaaa", + "location": "aaaaa", + "id": "aaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListOffers_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListOffers_MaximumSet_Gen.json new file mode 100644 index 000000000000..7cf54d00bff8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListOffers_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "location": "aaaaaaa", + "publisherName": "aaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "tags": { + "key7868": "aaaaa" + }, + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListOffers_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListOffers_MinimumSet_Gen.json new file mode 100644 index 000000000000..de735dc64c85 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListOffers_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListPublishers_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListPublishers_MaximumSet_Gen.json new file mode 100644 index 000000000000..4d7eb86841b2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListPublishers_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "location": "aaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "tags": { + "key7868": "aaaaa" + }, + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListPublishers_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListPublishers_MinimumSet_Gen.json new file mode 100644 index 000000000000..6498d79b313b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListPublishers_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListSkus_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListSkus_MaximumSet_Gen.json new file mode 100644 index 000000000000..63291e74d29e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListSkus_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "location": "aaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offer": "aaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "tags": { + "key7868": "aaaaa" + }, + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListSkus_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListSkus_MinimumSet_Gen.json new file mode 100644 index 000000000000..f470507c7083 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_ListSkus_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "aaaa", + "publisherName": "aaaaaaaaaaaaa", + "offer": "aaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..d89c05d2f539 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_List_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaa", + "publisherName": "aaaaaa", + "offer": "aaaaaaaaaaaaaaaa", + "skus": "aaaaaaaaaaaaaaaaaaaaaaa", + "$expand": "aaaaaaaaaaaaaaaaaaaaaaaa", + "$top": 18, + "$orderby": "aa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "tags": { + "key7868": "aaaaa" + }, + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..5af6e43d43c1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImage_List_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "location": "aaaaaaa", + "publisherName": "aaaaaaaaaaa", + "offer": "aaaaaaaaaa", + "skus": "aaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..319a4790377b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaaaaaaaaaaa", + "edgeZone": "aaaaaaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaaaaaa", + "offer": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "skus": "aaaaaaaaaa", + "version": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "properties": { + "plan": { + "publisher": "aaaaaaaaaaaaaaaaaaa", + "name": "aaaaaaaaa", + "product": "aaaaaaaaaaaaaa" + }, + "osDiskImage": { + "operatingSystem": "Windows" + }, + "dataDiskImages": [ + { + "lun": 17 + } + ], + "automaticOSUpgradeProperties": { + "automaticOSUpgradeSupported": true + }, + "hyperVGeneration": "V1", + "disallowed": { + "vmDiskType": "None" + }, + "features": [ + { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "value": "aaaaaaaaaaaaaaaaaaaa" + } + ] + }, + "name": "aaaaaaaaa", + "location": "aaaaa", + "tags": { + "key6817": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "aaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..eb69541251f0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaaaaaaaaaa", + "edgeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "offer": "aaaaaaaaaaa", + "skus": "aaaaaaaaaaaaaaaaaa", + "version": "aa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "name": "aaaaaaaaa", + "location": "aaaaa", + "id": "aaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen.json new file mode 100644 index 000000000000..2294be03d53a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "location": "WestUS", + "edgeZone": "microsoftlosangeles1", + "api-version": "2023-09-01", + "subscriptionId": "5ece5940-d962-4dad-a98f-ca9ac0f021a5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "18.04.202107200", + "location": "WestUS", + "extendedLocation": { + "name": "microsoftlosangeles1", + "type": "EdgeZone" + }, + "id": "/Subscriptions/5ece5940-d962-4dad-a98f-ca9ac0f021a5/Providers/Microsoft.Compute/Locations/westus/Publishers/CANONICAL/ArtifactTypes/VMImage/Offers/UBUNTUSERVER/Skus/18_04-LTS-GEN2/Versions/18.04.202107200" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen.json new file mode 100644 index 000000000000..725fd0b2f809 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "location": "WestUS", + "edgeZone": "microsoftlosangeles1", + "api-version": "2023-09-01", + "subscriptionId": "5ece5940-d962-4dad-a98f-ca9ac0f021a5" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen.json new file mode 100644 index 000000000000..93e444b109c3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaaaaa", + "edgeZone": "aaaaaaaaaaaaaaaaaaa", + "publisherName": "aaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "tags": { + "key7868": "aaaaa" + }, + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen.json new file mode 100644 index 000000000000..f7f667766d80 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaa", + "edgeZone": "aaaaaaaaaaaaaaaaaaaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen.json new file mode 100644 index 000000000000..35fa65120f38 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "location": "aaaaaa", + "edgeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "tags": { + "key7868": "aaaaa" + }, + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen.json new file mode 100644 index 000000000000..aa385022446b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "location": "aaaa", + "edgeZone": "aaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen.json new file mode 100644 index 000000000000..1de88a1aef65 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaa", + "edgeZone": "aaaaa", + "publisherName": "aaaaaaaaaaaa", + "offer": "aaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "tags": { + "key7868": "aaaaa" + }, + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen.json new file mode 100644 index 000000000000..7a695e03893c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaaaaaaa", + "edgeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherName": "aaaaaaaaa", + "offer": "aaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..288a11e50114 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaa", + "edgeZone": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "publisherName": "aaaa", + "offer": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "skus": "aaaaaaaaaaaaaaaaaaaaaaa", + "$expand": "aaaaaaaaaaaaaaaaaaaaaaaa", + "$top": 12, + "$orderby": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "tags": { + "key7868": "aaaaa" + }, + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..f002e02d30d7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "location": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "edgeZone": "aaaaa", + "publisherName": "aaaaaaaaaaaaaaaaaaa", + "offer": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "skus": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "name": "aaaaaaaa", + "location": "aaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaaa" + } + ] + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..73ce2d4cf983 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaa", + "vmssExtensionName": "aaaaaaaaaaaaaaaaaaaaa", + "extensionParameters": { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "forceUpdateTag": "aaaaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "aa" + ], + "suppressFailures": true + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "forceUpdateTag": "aaaaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "provisioningState": "aaa", + "provisionAfterExtensions": [ + "aa" + ], + "suppressFailures": true + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaa" + } + }, + "201": { + "headers": { + "location": "https://foo.com/operationstatus" + }, + "body": { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "forceUpdateTag": "aaaaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "provisioningState": "aaa", + "provisionAfterExtensions": [ + "aa" + ], + "suppressFailures": true + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..dd6a208ebf92 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaa", + "vmssExtensionName": "aaaaaaaaaaa", + "extensionParameters": {}, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "headers": { + "location": "https://foo.com/operationstatus" + }, + "body": {} + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..f57ed3cd1005 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmssExtensionName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..d4440c4b88f8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaa", + "vmssExtensionName": "aaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..02fdfa2d15a0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MaximumSet_Gen.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "vmssExtensionName": "aaaaaaaaaaaaaaaaaaaa", + "$expand": "aaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "forceUpdateTag": "aaaaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "provisioningState": "aaa", + "provisionAfterExtensions": [ + "aa" + ], + "suppressFailures": true + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..949d842d3c90 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MinimumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "a", + "vmssExtensionName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..46ba53dfb924 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "forceUpdateTag": "aaaaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "provisioningState": "aaa", + "provisionAfterExtensions": [ + "aa" + ], + "suppressFailures": true + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaa" + } + ], + "nextLink": "aa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..de7f5ef0c304 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + {} + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_RollingUpgrade.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_RollingUpgrade.json new file mode 100644 index 000000000000..a76333787c77 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_RollingUpgrade.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..5907de59f101 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmssExtensionName": "aaaa", + "extensionParameters": { + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "forceUpdateTag": "aaaaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "aa" + ], + "suppressFailures": true + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "forceUpdateTag": "aaaaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "provisioningState": "aaa", + "provisionAfterExtensions": [ + "aa" + ], + "suppressFailures": true + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaa" + } + }, + "201": { + "headers": { + "location": "https://foo.com/operationstatus" + }, + "body": { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "forceUpdateTag": "aaaaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "provisioningState": "aaa", + "provisionAfterExtensions": [ + "aa" + ], + "suppressFailures": true + }, + "type": "aaaaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..e5d71dac0e88 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmssExtensionName": "aa", + "extensionParameters": {}, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": {} + }, + "201": { + "headers": { + "location": "https://foo.com/operationstatus" + }, + "body": {} + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MaximumSet_Gen.json new file mode 100644 index 000000000000..8bd3bc33ddc8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MinimumSet_Gen.json new file mode 100644 index 000000000000..30361c14e393 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json new file mode 100644 index 000000000000..9fd9a18bb27c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "properties": { + "policy": { + "maxBatchInstancePercent": 49, + "maxUnhealthyInstancePercent": 81, + "maxUnhealthyUpgradedInstancePercent": 98, + "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa", + "enableCrossZoneUpgrade": true, + "prioritizeUnhealthyInstances": true, + "rollbackFailedInstancesOnPolicyBreach": true, + "maxSurge": true + }, + "runningStatus": { + "code": "RollingForward", + "startTime": "2021-11-30T13:06:23.362Z", + "lastAction": "Start", + "lastActionTime": "2021-11-30T13:06:23.362Z" + }, + "progress": { + "successfulInstanceCount": 6, + "failedInstanceCount": 25, + "inProgressInstanceCount": 20, + "pendingInstanceCount": 27 + }, + "error": { + "details": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaa", + "target": "aaaa", + "message": "aa" + } + ], + "innererror": { + "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaa" + }, + "code": "aaaaaaa", + "target": "aaaaaaa", + "message": "aaaaaaaaa" + } + }, + "id": "aaaaaaaaaa", + "name": "aaaaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaaaaaaaaaaaaaa", + "location": "aaaaaa", + "tags": { + "key8533": "aaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json new file mode 100644 index 000000000000..e8088da29ae7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "aaaaaa", + "id": "aaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3c921e5e255 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MinimumSet_Gen.json new file mode 100644 index 000000000000..8c76d42a2cb2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.json new file mode 100644 index 000000000000..5504fdcfabad --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2023-09-01", + "extensionParameters": { + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myVMExtension", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + }, + "200": { + "body": { + "name": "myVMExtension", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Delete.json new file mode 100644 index 000000000000..9baaa79c0efd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Get.json new file mode 100644 index 000000000000..7719715aebca --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + }, + "name": "myVMExtension", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.json new file mode 100644 index 000000000000..f1c62c1af815 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + }, + "name": "myVMExtension", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension" + }, + { + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "extPublisher1", + "type": "extType1", + "typeHandlerVersion": "1.0", + "settings": { + "UserName": "xyz@microsoft.com" + } + }, + "name": "myVMExtension1", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension1" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.json new file mode 100644 index 000000000000..71a627bb6ee6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2023-09-01", + "extensionParameters": { + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVMExtension", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ApproveRollingUpgrade.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ApproveRollingUpgrade.json new file mode 100644 index 000000000000..ea3a39069093 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ApproveRollingUpgrade.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "vmssToApproveRollingUpgradeOn", + "instanceId": "0123", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.json new file mode 100644 index 000000000000..0231b4a01cb4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "azure-vmscaleset", + "instanceId": "0", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}", + "parameters": { + "dataDisksToAttach": [ + { + "lun": 1, + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d" + }, + { + "lun": 2, + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e" + } + ], + "dataDisksToDetach": [ + { + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x", + "detachOption": "ForceDetach" + }, + { + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_4_disk4_4d4e784bdafa49baa780eb2d256ff41z", + "detachOption": "ForceDetach" + } + ] + } + }, + "responses": { + "200": { + "body": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [ + { + "lun": 1, + "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d" + }, + "diskSizeGB": 30 + }, + { + "lun": 2, + "name": "vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_2_disk3_7d5e664bdafa49baa780eb2d128ff38e" + }, + "diskSizeGB": 100 + } + ] + }, + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.json new file mode 100644 index 000000000000..b2355540988e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "azure-vmscaleset", + "instanceId": "0", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}", + "parameters": { + "dataDisksToAttach": [ + { + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d" + } + ], + "dataDisksToDetach": [ + { + "diskId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_1_disk1_1a4e784bdafa49baa780eb2d128ff65x" + } + ] + } + }, + "responses": { + "200": { + "body": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [ + { + "lun": 0, + "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d" + }, + "diskSizeGB": 30 + } + ] + }, + "headers": { + "location": "https://foo.com/operationstatus" + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MaximumSet_Gen.json new file mode 100644 index 000000000000..d5090a485911 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MinimumSet_Gen.json new file mode 100644 index 000000000000..1e4902968678 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "instanceId": "aaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Delete_Force.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Delete_Force.json new file mode 100644 index 000000000000..83886cbc7bad --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Delete_Force.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "forceDeletion": "true", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..912c988035ad --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "instanceId": "0", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "platformUpdateDomain": 0, + "platformFaultDomain": 0, + "rdpThumbPrint": null, + "vmAgent": { + "vmAgentVersion": "Unknown", + "statuses": [ + { + "code": "ProvisioningState/Unavailable", + "level": "Warning", + "displayStatus": "Not Ready", + "message": "VM status blob is found but not yet populated.", + "time": "2023-09-01T05:00:32+00:00" + } + ], + "extensionHandlers": null + }, + "disks": [ + { + "name": "myOSDisk", + "encryptionSettings": null, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": null, + "time": "2023-09-01T04:58:58.0882815+00:00" + } + ] + } + ], + "extensions": null, + "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost", + "bootDiagnostics": null, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": null, + "time": "2020-06-05T04:59:58.1852966+00:00" + }, + { + "code": "PowerState/running", + "level": "Info", + "displayStatus": "VM running", + "message": null, + "time": null + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json new file mode 100644 index 000000000000..68ac272c942a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "instanceId": "0", + "api-version": "2023-09-01", + "expand": "UserData" + }, + "responses": { + "200": { + "body": { + "name": "{vmss-vm-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0", + "type": "Microsoft.Compute/virtualMachines", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "etag": "\"1\"", + "properties": { + "latestModelApplied": true, + "modelDefinitionApplied": "VirtualMachineScaleSet", + "networkProfileConfiguration": { + "networkInterfaceConfigurations": [ + { + "name": "vmsstestnetconfig5415", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "dnsSettings": { + "dnsServers": [] + }, + "enableIPForwarding": false, + "ipConfigurations": [ + { + "name": "vmsstestnetconfig9693", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503" + }, + "privateIPAddressVersion": "IPv4" + } + } + ] + } + } + ] + }, + "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619", + "hardwareProfile": {}, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20180315", + "exactVersion": "4.127.20180315" + }, + "osDisk": { + "osType": "Windows", + "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc", + "createOption": "FromImage", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc" + }, + "diskSizeGB": 127 + }, + "dataDisks": [ + { + "lun": 1, + "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "createOption": "Empty", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d" + }, + "diskSizeGB": 128, + "toBeDetached": false + } + ] + }, + "osProfile": { + "computerName": "test000000", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415" + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "provisioningState": "Succeeded" + }, + "resources": [ + { + "name": "CustomScriptExtension-DSC", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC", + "type": "Microsoft.Compute/virtualMachines/extensions", + "location": "westus", + "tags": { + "displayName": "CustomScriptExtension-DSC" + }, + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.9", + "settings": {} + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json new file mode 100644 index 000000000000..8e66f41aba3d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "instanceId": "0", + "api-version": "2023-09-01", + "expand": "UserData" + }, + "responses": { + "200": { + "body": { + "name": "{vmss-vm-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0", + "type": "Microsoft.Compute/virtualMachines", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "etag": "\"1\"", + "properties": { + "latestModelApplied": true, + "modelDefinitionApplied": "VirtualMachineScaleSet", + "networkProfileConfiguration": { + "networkInterfaceConfigurations": [ + { + "name": "vmsstestnetconfig5415", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "dnsSettings": { + "dnsServers": [] + }, + "enableIPForwarding": false, + "ipConfigurations": [ + { + "name": "vmsstestnetconfig9693", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503" + }, + "privateIPAddressVersion": "IPv4" + } + } + ] + } + } + ] + }, + "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619", + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20180315", + "exactVersion": "4.127.20180315" + }, + "osDisk": { + "osType": "Windows", + "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc", + "createOption": "FromImage", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc" + }, + "diskSizeGB": 127 + }, + "dataDisks": [ + { + "lun": 1, + "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "createOption": "Empty", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d" + }, + "diskSizeGB": 128, + "toBeDetached": false + } + ] + }, + "osProfile": { + "computerName": "test000000", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415" + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "provisioningState": "Succeeded" + }, + "resources": [ + { + "name": "CustomScriptExtension-DSC", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC", + "type": "Microsoft.Compute/virtualMachines/extensions", + "location": "westus", + "tags": { + "displayName": "CustomScriptExtension-DSC" + }, + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.9", + "settings": {} + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..c8ec026ad877 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MaximumSet_Gen.json @@ -0,0 +1,546 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "virtualMachineScaleSetName": "aaaaaaaaaaaaaaaaaaaaaa", + "$filter": "aaaaaaaaaaaaaa", + "$select": "aaaaaaaaaaaaaaaaaaaaa", + "$expand": "aaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{vmss-vm-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0", + "type": "Microsoft.Compute/virtualMachines", + "location": "westus", + "tags": {}, + "properties": { + "latestModelApplied": true, + "modelDefinitionApplied": "VirtualMachineScaleSet", + "networkProfileConfiguration": { + "networkInterfaceConfigurations": [ + { + "name": "vmsstestnetconfig5415", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "dnsSettings": { + "dnsServers": [] + }, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "vmsstestnetconfig9693", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503" + }, + "privateIPAddressVersion": "IPv4", + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 18, + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "deleteOption": "Delete" + } + } + ] + }, + "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619", + "hardwareProfile": { + "vmSize": "Basic_A0", + "vmSizeProperties": { + "vCPUsAvailable": 9, + "vCPUsPerCore": 12 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20180315", + "exactVersion": "4.127.20180315", + "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa", + "id": "a" + }, + "osDisk": { + "osType": "Windows", + "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc", + "createOption": "FromImage", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskSizeGB": 127, + "encryptionSettings": { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + }, + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "lun": 1, + "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "createOption": "Empty", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskSizeGB": 128, + "toBeDetached": true, + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diskIOPSReadWrite": 18, + "diskMBpsReadWrite": 29, + "detachOption": "ForceDetach", + "deleteOption": "Delete" + } + ] + }, + "osProfile": { + "computerName": "test000000", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true, + "customData": "aaaa", + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaa", + "keyData": "aaaaaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + } + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415", + "properties": { + "primary": true, + "deleteOption": "Delete" + } + } + ], + "networkApiVersion": "2020-11-01", + "networkInterfaceConfigurations": [ + { + "name": "aaaaaaaaaaa", + "properties": { + "primary": true, + "deleteOption": "Delete", + "enableAcceleratedNetworking": true, + "enableFpga": true, + "enableIPForwarding": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "dnsSettings": { + "dnsServers": [ + "aaaaaa" + ] + }, + "ipConfigurations": [ + { + "name": "aa", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 2, + "deleteOption": "Delete", + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "dscpConfiguration": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + } + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaa" + } + }, + "provisioningState": "Succeeded", + "instanceView": { + "platformUpdateDomain": 23, + "platformFaultDomain": 14, + "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmAgent": { + "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa", + "extensionHandlers": [ + { + "type": "aaaaaaaaaaaaa", + "typeHandlerVersion": "aaaaa", + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + }, + "maintenanceRedeployStatus": { + "isCustomerInitiatedMaintenanceAllowed": true, + "preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z", + "preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z", + "maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z", + "maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z", + "lastOperationResultCode": "None", + "lastOperationMessage": "aaaaaa" + }, + "disks": [ + { + "name": "aaaaaaaaaaa", + "encryptionSettings": [ + { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ], + "extensions": [ + { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ], + "vmHealth": { + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + }, + "bootDiagnostics": { + "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "serialConsoleLogBlobUri": "aaaaaaaa", + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "assignedHost": "aaaaaaa", + "placementGroupId": "aaa" + }, + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "licenseType": "aaaaaaaaaa", + "protectionPolicy": { + "protectFromScaleIn": true, + "protectFromScaleSetActions": true + }, + "timeCreated": "2021-06-27T01:02:38.3138469+00:00" + }, + "resources": [ + { + "name": "CustomScriptExtension-DSC", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC", + "type": "Microsoft.Compute/virtualMachines/extensions", + "location": "westus", + "tags": {}, + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.9", + "settings": {}, + "forceUpdateTag": "aaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "instanceView": { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + }, + "suppressFailures": true + } + } + ], + "instanceId": "aaaaaaaaaaaa", + "sku": { + "name": "Classic", + "tier": "aaaaaaaaaaaaaa", + "capacity": 29 + }, + "plan": { + "name": "aaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaaaaaaaa" + }, + "zones": [ + "a" + ] + } + ], + "nextLink": "aaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..8986d78423ff --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "virtualMachineScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MaximumSet_Gen.json new file mode 100644 index 000000000000..972ac5a8750b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MinimumSet_Gen.json new file mode 100644 index 000000000000..4398352842dd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaa", + "instanceId": "aaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MaximumSet_Gen.json new file mode 100644 index 000000000000..6c0cfa223350 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaa", + "instanceId": "aaaaaaaaa", + "skipShutdown": true, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MinimumSet_Gen.json new file mode 100644 index 000000000000..4384f8d51ed7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MaximumSet_Gen.json new file mode 100644 index 000000000000..12760343137c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MinimumSet_Gen.json new file mode 100644 index 000000000000..8252aa360c8e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MaximumSet_Gen.json new file mode 100644 index 000000000000..aa30ea27ff43 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MinimumSet_Gen.json new file mode 100644 index 000000000000..76ad5bdd0318 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MaximumSet_Gen.json new file mode 100644 index 000000000000..3c7b2d3c9695 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmScaleSetVMReimageInput": { + "tempDisk": true + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MinimumSet_Gen.json new file mode 100644 index 000000000000..035c2ce5c810 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaa", + "instanceId": "aaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MaximumSet_Gen.json new file mode 100644 index 000000000000..409ddd39b1f4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aa", + "instanceId": "aaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MinimumSet_Gen.json new file mode 100644 index 000000000000..7f56921f35b9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaa", + "instanceId": "aaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_RetrieveBootDiagnosticsData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_RetrieveBootDiagnosticsData.json new file mode 100644 index 000000000000..a5af2f6f9dd3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_RetrieveBootDiagnosticsData.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2023-09-01", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "sasUriExpirationTimeInMinutes": 60 + }, + "responses": { + "200": { + "body": { + "consoleScreenshotBlobUri": "https://storageuri/myvmScaleSetinstance.screenshot.bmp?{saskey}", + "serialConsoleLogBlobUri": "https://storageuri/myvmScaleSetinstance.serialconsole.log?{saskey}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_SimulateEviction.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_SimulateEviction.json new file mode 100644 index 000000000000..613cce613375 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_SimulateEviction.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "vmScaleSetName": "VmScaleSetName", + "api-version": "2023-09-01", + "instanceId": "InstanceId" + }, + "responses": { + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MaximumSet_Gen.json new file mode 100644 index 000000000000..8c9e52cd0fa7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MinimumSet_Gen.json new file mode 100644 index 000000000000..aac6c609bdef --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..ee04bcedf50b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MaximumSet_Gen.json @@ -0,0 +1,1533 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "parameters": { + "location": "westus", + "tags": {}, + "properties": { + "networkProfileConfiguration": { + "networkInterfaceConfigurations": [ + { + "name": "vmsstestnetconfig5415", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "dnsSettings": { + "dnsServers": [] + }, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "vmsstestnetconfig9693", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503" + }, + "privateIPAddressVersion": "IPv4", + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 18, + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "deleteOption": "Delete" + } + } + ] + }, + "hardwareProfile": { + "vmSize": "Basic_A0", + "vmSizeProperties": { + "vCPUsAvailable": 9, + "vCPUsPerCore": 12 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20180315", + "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa", + "id": "a" + }, + "osDisk": { + "osType": "Windows", + "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc", + "createOption": "FromImage", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskSizeGB": 127, + "encryptionSettings": { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + }, + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "lun": 1, + "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "createOption": "Empty", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskSizeGB": 128, + "toBeDetached": true, + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "detachOption": "ForceDetach", + "deleteOption": "Delete" + } + ] + }, + "osProfile": { + "computerName": "test000000", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true, + "adminPassword": "aaaaaaaaaaaaaaaa", + "customData": "aaaa", + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaa", + "keyData": "aaaaaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + } + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415", + "properties": { + "primary": true, + "deleteOption": "Delete" + } + } + ], + "networkApiVersion": "2020-11-01", + "networkInterfaceConfigurations": [ + { + "name": "aaaaaaaaaaa", + "properties": { + "primary": true, + "deleteOption": "Delete", + "enableAcceleratedNetworking": true, + "enableFpga": true, + "enableIPForwarding": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "dnsSettings": { + "dnsServers": [ + "aaaaaa" + ] + }, + "ipConfigurations": [ + { + "name": "aa", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 2, + "deleteOption": "Delete", + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "dscpConfiguration": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + } + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaa" + } + }, + "instanceView": { + "platformUpdateDomain": 23, + "platformFaultDomain": 14, + "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmAgent": { + "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa", + "extensionHandlers": [ + { + "type": "aaaaaaaaaaaaa", + "typeHandlerVersion": "aaaaa", + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + }, + "maintenanceRedeployStatus": { + "isCustomerInitiatedMaintenanceAllowed": true, + "preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z", + "preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z", + "maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z", + "maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z", + "lastOperationResultCode": "None", + "lastOperationMessage": "aaaaaa" + }, + "disks": [ + { + "name": "aaaaaaaaaaa", + "encryptionSettings": [ + { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ], + "extensions": [ + { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ], + "vmHealth": { + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + }, + "bootDiagnostics": { + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "placementGroupId": "aaa" + }, + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "licenseType": "aaaaaaaaaa", + "protectionPolicy": { + "protectFromScaleIn": true, + "protectFromScaleSetActions": true + } + }, + "sku": { + "name": "Classic", + "tier": "aaaaaaaaaaaaaa", + "capacity": 29 + }, + "plan": { + "name": "aaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaaaaaaaa" + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "name": "{vmss-vm-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0", + "type": "Microsoft.Compute/virtualMachines", + "location": "westus", + "tags": {}, + "properties": { + "latestModelApplied": true, + "modelDefinitionApplied": "VirtualMachineScaleSet", + "networkProfileConfiguration": { + "networkInterfaceConfigurations": [ + { + "name": "vmsstestnetconfig5415", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "dnsSettings": { + "dnsServers": [] + }, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "vmsstestnetconfig9693", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503" + }, + "privateIPAddressVersion": "IPv4", + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 18, + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "deleteOption": "Delete" + } + } + ] + }, + "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619", + "hardwareProfile": { + "vmSize": "Basic_A0", + "vmSizeProperties": { + "vCPUsAvailable": 9, + "vCPUsPerCore": 12 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20180315", + "exactVersion": "4.127.20180315", + "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa", + "id": "a" + }, + "osDisk": { + "osType": "Windows", + "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc", + "createOption": "FromImage", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskSizeGB": 127, + "encryptionSettings": { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + }, + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "lun": 1, + "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "createOption": "Empty", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskSizeGB": 128, + "toBeDetached": true, + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diskIOPSReadWrite": 18, + "diskMBpsReadWrite": 29, + "detachOption": "ForceDetach", + "deleteOption": "Delete" + } + ] + }, + "osProfile": { + "computerName": "test000000", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true, + "customData": "aaaa", + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaa", + "keyData": "aaaaaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + } + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415", + "properties": { + "primary": true, + "deleteOption": "Delete" + } + } + ], + "networkApiVersion": "2020-11-01", + "networkInterfaceConfigurations": [ + { + "name": "aaaaaaaaaaa", + "properties": { + "primary": true, + "deleteOption": "Delete", + "enableAcceleratedNetworking": true, + "enableFpga": true, + "enableIPForwarding": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "dnsSettings": { + "dnsServers": [ + "aaaaaa" + ] + }, + "ipConfigurations": [ + { + "name": "aa", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 2, + "deleteOption": "Delete", + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "dscpConfiguration": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + } + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaa" + } + }, + "provisioningState": "Succeeded", + "instanceView": { + "platformUpdateDomain": 23, + "platformFaultDomain": 14, + "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmAgent": { + "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa", + "extensionHandlers": [ + { + "type": "aaaaaaaaaaaaa", + "typeHandlerVersion": "aaaaa", + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + }, + "maintenanceRedeployStatus": { + "isCustomerInitiatedMaintenanceAllowed": true, + "preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z", + "preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z", + "maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z", + "maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z", + "lastOperationResultCode": "None", + "lastOperationMessage": "aaaaaa" + }, + "disks": [ + { + "name": "aaaaaaaaaaa", + "encryptionSettings": [ + { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ], + "extensions": [ + { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ], + "vmHealth": { + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + }, + "bootDiagnostics": { + "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "serialConsoleLogBlobUri": "aaaaaaaa", + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "assignedHost": "aaaaaaa", + "placementGroupId": "aaa" + }, + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "licenseType": "aaaaaaaaaa", + "protectionPolicy": { + "protectFromScaleIn": true, + "protectFromScaleSetActions": true + } + }, + "resources": [ + { + "name": "CustomScriptExtension-DSC", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC", + "type": "Microsoft.Compute/virtualMachines/extensions", + "location": "westus", + "tags": {}, + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.9", + "settings": {}, + "forceUpdateTag": "aaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "instanceView": { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + }, + "suppressFailures": true + } + } + ], + "instanceId": "aaaaaaaaaaaa", + "sku": { + "name": "Classic", + "tier": "aaaaaaaaaaaaaa", + "capacity": 29 + }, + "plan": { + "name": "aaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaaaaaaaa" + }, + "zones": [ + "a" + ] + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + }, + "body": { + "name": "{vmss-vm-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0", + "type": "Microsoft.Compute/virtualMachines", + "location": "westus", + "tags": {}, + "properties": { + "latestModelApplied": true, + "modelDefinitionApplied": "VirtualMachineScaleSet", + "networkProfileConfiguration": { + "networkInterfaceConfigurations": [ + { + "name": "vmsstestnetconfig5415", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "dnsSettings": { + "dnsServers": [] + }, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "vmsstestnetconfig9693", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503" + }, + "privateIPAddressVersion": "IPv4", + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 18, + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "deleteOption": "Delete" + } + } + ] + }, + "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619", + "hardwareProfile": { + "vmSize": "Basic_A0", + "vmSizeProperties": { + "vCPUsAvailable": 9, + "vCPUsPerCore": 12 + } + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20180315", + "exactVersion": "4.127.20180315", + "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa", + "id": "a" + }, + "osDisk": { + "osType": "Windows", + "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc", + "createOption": "FromImage", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskSizeGB": 127, + "encryptionSettings": { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + }, + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "lun": 1, + "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "createOption": "Empty", + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskSizeGB": 128, + "toBeDetached": true, + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "writeAcceleratorEnabled": true, + "diskIOPSReadWrite": 18, + "diskMBpsReadWrite": 29, + "detachOption": "ForceDetach", + "deleteOption": "Delete" + } + ] + }, + "osProfile": { + "computerName": "test000000", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "secrets": [], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true, + "customData": "aaaa", + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaa", + "keyData": "aaaaaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + } + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415", + "properties": { + "primary": true, + "deleteOption": "Delete" + } + } + ], + "networkApiVersion": "2020-11-01", + "networkInterfaceConfigurations": [ + { + "name": "aaaaaaaaaaa", + "properties": { + "primary": true, + "deleteOption": "Delete", + "enableAcceleratedNetworking": true, + "enableFpga": true, + "enableIPForwarding": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "dnsSettings": { + "dnsServers": [ + "aaaaaa" + ] + }, + "ipConfigurations": [ + { + "name": "aa", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 2, + "deleteOption": "Delete", + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "dscpConfiguration": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + } + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaa" + } + }, + "provisioningState": "Succeeded", + "instanceView": { + "platformUpdateDomain": 23, + "platformFaultDomain": 14, + "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmAgent": { + "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa", + "extensionHandlers": [ + { + "type": "aaaaaaaaaaaaa", + "typeHandlerVersion": "aaaaa", + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + }, + "maintenanceRedeployStatus": { + "isCustomerInitiatedMaintenanceAllowed": true, + "preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z", + "preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z", + "maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z", + "maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z", + "lastOperationResultCode": "None", + "lastOperationMessage": "aaaaaa" + }, + "disks": [ + { + "name": "aaaaaaaaaaa", + "encryptionSettings": [ + { + "diskEncryptionKey": { + "secretUrl": "aaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "keyEncryptionKey": { + "keyUrl": "aaaaaaaaaaaaaa", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "enabled": true + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ], + "extensions": [ + { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + } + ], + "vmHealth": { + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + }, + "bootDiagnostics": { + "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "serialConsoleLogBlobUri": "aaaaaaaa", + "status": { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + }, + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "assignedHost": "aaaaaaa", + "placementGroupId": "aaa" + }, + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "licenseType": "aaaaaaaaaa", + "protectionPolicy": { + "protectFromScaleIn": true, + "protectFromScaleSetActions": true + } + }, + "resources": [ + { + "name": "CustomScriptExtension-DSC", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC", + "type": "Microsoft.Compute/virtualMachines/extensions", + "location": "westus", + "tags": {}, + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.9", + "settings": {}, + "forceUpdateTag": "aaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "instanceView": { + "name": "aaaaaaaaaaaaaaaaa", + "type": "aaaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "substatuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ], + "statuses": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaa", + "level": "Info", + "displayStatus": "aaaaaa", + "message": "a", + "time": "2021-11-30T12:58:26.522Z" + } + ] + }, + "suppressFailures": true + } + } + ], + "instanceId": "aaaaaaaaaaaa", + "sku": { + "name": "Classic", + "tier": "aaaaaaaaaaaaaa", + "capacity": 29 + }, + "plan": { + "name": "aaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaaaaaaaa" + }, + "zones": [ + "a" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..425e8b7f194b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MinimumSet_Gen.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaa", + "instanceId": "aaaaaaaaaaaaaaaaaaaa", + "parameters": { + "location": "westus" + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0" + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + }, + "body": { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ApproveRollingUpgrade.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ApproveRollingUpgrade.json new file mode 100644 index 000000000000..fc469a00c7dd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ApproveRollingUpgrade.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "vmssToApproveRollingUpgradeOn", + "vmInstanceIDs": { + "instanceIds": [ + "0", + "1", + "2" + ] + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..26ac998426af --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "parameters": { + "activePlacementGroupId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MinimumSet_Gen.json new file mode 100644 index 000000000000..ad0d38e8c3d5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaa", + "parameters": {}, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacement.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacement.json new file mode 100644 index 000000000000..76d31e264cbd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacement.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_CustomImageFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_CustomImageFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..8ccdc970caae --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_CustomImageFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "caching": "ReadWrite", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17", + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17", + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromACustomImage.json new file mode 100644 index 000000000000..81438dabd14b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromACustomImage.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json new file mode 100644 index 000000000000..497c6fed8257 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromASpecializedSharedImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromASpecializedSharedImage.json new file mode 100644 index 000000000000..0abcab8730ef --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromASpecializedSharedImage.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/mySharedGallery/images/mySharedImage" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithDisableTcpStateTrackingNetworkInterface.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithDisableTcpStateTrackingNetworkInterface.json new file mode 100644 index 000000000000..ad221af99e22 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithDisableTcpStateTrackingNetworkInterface.json @@ -0,0 +1,277 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{nicConfig1-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "disableTcpStateTracking": true, + "enableAcceleratedNetworking": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + }, + { + "name": "{nicConfig2-name}", + "properties": { + "primary": false, + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "disableTcpStateTracking": false, + "ipConfigurations": [ + { + "name": "{nicConfig2-name}", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name2}" + }, + "privateIPAddressVersion": "IPv4" + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{nicConfig1-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "disableTcpStateTracking": true, + "ipConfigurations": [ + { + "name": "{nicConfig1-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": true + } + }, + { + "name": "{nicConfig2-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": false, + "enableFpga": false, + "disableTcpStateTracking": false, + "ipConfigurations": [ + { + "name": "{nicConfig2-name}", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name2}" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{nicConfig1-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "disableTcpStateTracking": true, + "ipConfigurations": [ + { + "name": "{nicConfig1-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": true + } + }, + { + "name": "{nicConfig2-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": false, + "enableFpga": false, + "disableTcpStateTracking": false, + "ipConfigurations": [ + { + "name": "{nicConfig2-name}", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name2}" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithFpgaNetworkInterface.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithFpgaNetworkInterface.json new file mode 100644 index 000000000000..9de693585977 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithFpgaNetworkInterface.json @@ -0,0 +1,271 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + }, + { + "name": "{fpgaNic-Name}", + "properties": { + "primary": false, + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "enableFpga": true, + "ipConfigurations": [ + { + "name": "{fpgaNic-Name}", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name}" + }, + "privateIPAddressVersion": "IPv4" + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + }, + { + "name": "{fpgaNic-Name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": false, + "enableFpga": true, + "ipConfigurations": [ + { + "name": "{fpgaNic-Name}", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name}" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + }, + { + "name": "{fpgaNic-Name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": false, + "enableFpga": true, + "ipConfigurations": [ + { + "name": "{fpgaNic-Name}", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name}" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithNetworkInterfaceWithDnsSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithNetworkInterfaceWithDnsSettings.json new file mode 100644 index 000000000000..732fc60cf31f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithNetworkInterfaceWithDnsSettings.json @@ -0,0 +1,303 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{nicConfig1-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "disableTcpStateTracking": true, + "enableAcceleratedNetworking": true, + "auxiliaryMode": "AcceleratedConnections", + "auxiliarySku": "A1", + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + }, + { + "name": "{nicConfig2-name}", + "properties": { + "primary": false, + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "disableTcpStateTracking": false, + "ipConfigurations": [ + { + "name": "{nicConfig2-name}", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name2}" + }, + "privateIPAddressVersion": "IPv4", + "publicIPAddressConfiguration": { + "name": "publicip", + "properties": { + "idleTimeoutInMinutes": 10, + "dnsSettings": { + "domainNameLabel": "vmsstestlabel01", + "domainNameLabelScope": "NoReuse" + } + } + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{nicConfig1-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "disableTcpStateTracking": true, + "ipConfigurations": [ + { + "name": "{nicConfig1-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4", + "publicIPAddressConfiguration": { + "name": "publicip", + "properties": { + "idleTimeoutInMinutes": 10, + "dnsSettings": { + "domainNameLabel": "vmsstestlabel01", + "domainNameLabelScope": "TenantReuse" + } + } + } + } + } + ], + "enableAcceleratedNetworking": true, + "auxiliaryMode": "AcceleratedConnections", + "auxiliarySku": "A1" + } + }, + { + "name": "{nicConfig2-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": false, + "enableFpga": false, + "disableTcpStateTracking": false, + "ipConfigurations": [ + { + "name": "{nicConfig2-name}", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name2}" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{nicConfig1-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "disableTcpStateTracking": true, + "ipConfigurations": [ + { + "name": "{nicConfig1-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": true, + "auxiliaryMode": "AcceleratedConnections", + "auxiliarySku": "A1" + } + }, + { + "name": "{nicConfig2-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": false, + "enableFpga": false, + "disableTcpStateTracking": false, + "ipConfigurations": [ + { + "name": "{nicConfig2-name}", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-fpga-subnet-name2}" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_PlatformImageWithUnmanagedOsDisks.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_PlatformImageWithUnmanagedOsDisks.json new file mode 100644 index 000000000000..5a63ae17bf99 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_PlatformImageWithUnmanagedOsDisks.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "osDisk", + "vhdContainers": [ + "http://{existing-storage-account-name-0}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-1}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-2}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-3}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-4}.blob.core.windows.net/vhdContainer" + ] + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..22a29b6b94a8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAMarketplaceImagePlan.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithApplicationProfile.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithApplicationProfile.json new file mode 100644 index 000000000000..2f36ae277b78 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithApplicationProfile.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": false + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config" + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config" + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAutomaticRepairs.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAutomaticRepairs.json new file mode 100644 index 000000000000..688d479852cc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAutomaticRepairs.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT10M" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT10M" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT10M" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureApplicationGateway.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureApplicationGateway.json new file mode 100644 index 000000000000..b97e13fd95d0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureApplicationGateway.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/{existing-application-gateway-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureLoadBalancer.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureLoadBalancer.json new file mode 100644 index 000000000000..ee92119b9305 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureLoadBalancer.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + }, + "publicIPAddressConfiguration": { + "name": "{vmss-name}", + "properties": { + "publicIPAddressVersion": "IPv4" + } + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/inboundNatPools/{existing-nat-pool-name}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ] + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithBootDiagnostics.json new file mode 100644 index 000000000000..e7b27507b366 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithBootDiagnostics.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithCapacityReservation.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithCapacityReservation.json new file mode 100644 index 000000000000..61c7e862eb3e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithCapacityReservation.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + }, + "capacityReservation": { + "capacityReservationGroup": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "capacityReservation": { + "capacityReservationGroup": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "capacityReservation": { + "capacityReservationGroup": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/CapacityReservationGroups/{crgName}" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiffOsDisk.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiffOsDisk.json new file mode 100644 index 000000000000..aadd9dbcd134 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiffOsDisk.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskControllerType.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskControllerType.json new file mode 100644 index 000000000000..b63781780bc6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskControllerType.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "upgradePolicy": { + "mode": "Manual" + }, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "diskControllerType": "NVMe" + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "diskControllerType": "NVMe" + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + }, + "diskControllerType": "SCSI" + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskEncryptionSetResource.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskEncryptionSetResource.json new file mode 100644 index 000000000000..953060f6b037 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskEncryptionSetResource.json @@ -0,0 +1,255 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEmptyDataDisksOnEachVm.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEmptyDataDisksOnEachVm.json new file mode 100644 index 000000000000..ae7fa9596c2d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEmptyDataDisksOnEachVm.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Succeeded" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEncryptionAtHost.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEncryptionAtHost.json new file mode 100644 index 000000000000..ba56c8870729 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEncryptionAtHost.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "encryptionAtHost": true + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "encryptionAtHost": true + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "encryptionAtHost": true + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsSuppressFailuresEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsSuppressFailuresEnabled.json new file mode 100644 index 000000000000..a1dd37299538 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsSuppressFailuresEnabled.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "suppressFailures": true + } + } + ] + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "suppressFailures": true + } + } + ] + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "suppressFailures": true + } + } + ] + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsTimeBudget.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsTimeBudget.json new file mode 100644 index 000000000000..7dc0441493eb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsTimeBudget.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {} + } + } + ], + "extensionsTimeBudget": "PT1H20M" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {} + } + } + ], + "extensionsTimeBudget": "PT1H20M" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {} + } + } + ], + "extensionsTimeBudget": "PT1H20M" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithManagedBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithManagedBootDiagnostics.json new file mode 100644 index 000000000000..5c76eb3982a0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithManagedBootDiagnostics.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithOSImageScheduledEventEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithOSImageScheduledEventEnabled.json new file mode 100644 index 000000000000..eda9412a3a98 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithOSImageScheduledEventEnabled.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + }, + "scheduledEventsProfile": { + "osImageNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT15M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "scheduledEventsProfile": { + "osImageNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT15M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "scheduledEventsProfile": { + "osImageNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT15M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPasswordAuthentication.json new file mode 100644 index 000000000000..3d22b1e2de6e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPasswordAuthentication.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPremiumStorage.json new file mode 100644 index 000000000000..c8a7c22be66d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPremiumStorage.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPriorityMixPolicy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPriorityMixPolicy.json new file mode 100644 index 000000000000..521cf3886c3e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPriorityMixPolicy.json @@ -0,0 +1,234 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 10, + "name": "Standard_A8m_v2" + }, + "location": "westus", + "properties": { + "singlePlacementGroup": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + }, + "priority": "Spot", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": -1 + } + }, + "orchestrationMode": "Flexible", + "priorityMixPolicy": { + "baseRegularPriorityCount": 4, + "regularPriorityPercentageAboveBase": 50 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 10, + "name": "Standard_A8m_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "priority": "Spot", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": -1 + } + }, + "orchestrationMode": "Flexible", + "priorityMixPolicy": { + "baseRegularPriorityCount": 4, + "regularPriorityPercentageAboveBase": 50 + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 10, + "name": "Standard_A8m_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "priority": "Spot", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": -1 + } + }, + "orchestrationMode": "Flexible", + "priorityMixPolicy": { + "baseRegularPriorityCount": 4, + "regularPriorityPercentageAboveBase": 50 + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProtectedSettingsFromKeyVault.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProtectedSettingsFromKeyVault.json new file mode 100644 index 000000000000..708ed4919494 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProtectedSettingsFromKeyVault.json @@ -0,0 +1,293 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "protectedSettingsFromKeyVault": { + "sourceVault": { + "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName" + }, + "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e" + } + } + } + ] + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "protectedSettingsFromKeyVault": { + "sourceVault": { + "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName" + }, + "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e" + } + } + } + ] + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "protectedSettingsFromKeyVault": { + "sourceVault": { + "id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName" + }, + "secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e" + } + } + } + ] + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProxyAgentSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProxyAgentSettings.json new file mode 100644 index 000000000000..a8cbd77e1d1a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProxyAgentSettings.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2s_v3" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "proxyAgentSettings": { + "enabled": true, + "mode": "Enforce" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2s_v3" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "proxyAgentSettings": { + "enabled": true, + "mode": "Enforce" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2s_v3" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-Datacenter", + "version": "latest" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "proxyAgentSettings": { + "enabled": true, + "mode": "Enforce" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMCreationPolicy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMCreationPolicy.json new file mode 100644 index 000000000000..13e592c57d6f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMCreationPolicy.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "resiliencyPolicy": { + "resilientVMCreationPolicy": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": false, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "resiliencyPolicy": { + "resilientVMCreationPolicy": { + "enabled": true + } + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": false, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "resiliencyPolicy": { + "resilientVMCreationPolicy": { + "enabled": true + } + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMDeletionPolicy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMDeletionPolicy.json new file mode 100644 index 000000000000..c5d79128063a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMDeletionPolicy.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "resiliencyPolicy": { + "resilientVMDeletionPolicy": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": false, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "resiliencyPolicy": { + "resilientVMDeletionPolicy": { + "enabled": true + } + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": false, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "resiliencyPolicy": { + "resilientVMDeletionPolicy": { + "enabled": true + } + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithScaleInPolicy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithScaleInPolicy.json new file mode 100644 index 000000000000..a27fd3a2ecb6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithScaleInPolicy.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "scaleInPolicy": { + "rules": [ + "OldestVM" + ], + "forceDeletion": true + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "scaleInPolicy": { + "rules": [ + "OldestVM" + ], + "forceDeletion": true + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "scaleInPolicy": { + "rules": [ + "OldestVM" + ], + "forceDeletion": true + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json new file mode 100644 index 000000000000..21fff599920b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_A1" + }, + "location": "eastus2euap", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + }, + "storageProfile": { + "imageReference": { + "sku": "2022-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_A1" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d12ccb3d-ab15-4794-9836-c4196392e9f2", + "virtualMachineProfile": { + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + }, + "storageProfile": { + "imageReference": { + "sku": "2022-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + } + }, + "provisioningState": "Creating" + }, + "location": "eastus2euap", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_A1" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d12ccb3d-ab15-4794-9836-c4196392e9f2", + "virtualMachineProfile": { + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + }, + "storageProfile": { + "imageReference": { + "sku": "2022-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + } + }, + "provisioningState": "Creating" + }, + "location": "eastus2euap", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVM.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVM.json new file mode 100644 index 000000000000..a5cc2389cd43 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVM.json @@ -0,0 +1,245 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DC2as_v5" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows-cvm", + "publisher": "MicrosoftWindowsServer", + "version": "17763.2183.2109130127", + "offer": "2019-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly" + } + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DC2as_v5" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows-cvm", + "publisher": "MicrosoftWindowsServer", + "version": "17763.2183.2109130127", + "offer": "2019-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly" + } + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DC2as_v5" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows-cvm", + "publisher": "MicrosoftWindowsServer", + "version": "17763.2183.2109130127", + "offer": "2019-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly" + } + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json new file mode 100644 index 000000000000..459843781798 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json @@ -0,0 +1,245 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DC2es_v5" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "linux-cvm", + "publisher": "UbuntuServer", + "version": "17763.2183.2109130127", + "offer": "2022-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": false, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DC2es_v5" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "linux-cvm", + "publisher": "UbuntuServer", + "version": "17763.2183.2109130127", + "offer": "2022-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": false, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DC2es_v5" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "linux-cvm", + "publisher": "UbuntuServer", + "version": "17763.2183.2109130127", + "offer": "2022-datacenter-cvm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS", + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": false, + "vTpmEnabled": true + }, + "securityType": "ConfidentialVM" + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithServiceArtifactReference.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithServiceArtifactReference.json new file mode 100644 index 000000000000..313c362a8d1f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithServiceArtifactReference.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_A1" + }, + "location": "eastus2euap", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "serviceArtifactReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/serviceArtifacts/serviceArtifactName/vmArtifactsProfiles/vmArtifactsProfilesName" + }, + "storageProfile": { + "imageReference": { + "sku": "2022-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_A1" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "serviceArtifactReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/serviceArtifacts/serviceArtifactName/vmArtifactsProfiles/vmArtifactsProfilesName" + }, + "storageProfile": { + "imageReference": { + "sku": "2022-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + } + }, + "provisioningState": "Creating" + }, + "location": "eastus2euap", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_A1" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "serviceArtifactReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/serviceArtifacts/serviceArtifactName/vmArtifactsProfiles/vmArtifactsProfilesName" + }, + "storageProfile": { + "imageReference": { + "sku": "2022-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + } + }, + "provisioningState": "Creating" + }, + "location": "eastus2euap", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSpotRestorePolicy.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSpotRestorePolicy.json new file mode 100644 index 000000000000..74b67fac779f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSpotRestorePolicy.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A8m_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + }, + "priority": "Spot", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": -1 + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "spotRestorePolicy": { + "enabled": true, + "restoreTimeout": "PT1H" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A8m_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "priority": "Spot", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": -1 + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "spotRestorePolicy": { + "enabled": true, + "restoreTimeout": "PT1H" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A8m_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "priority": "Spot", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": -1 + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "spotRestorePolicy": { + "enabled": true, + "restoreTimeout": "PT1H" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSshAuthentication.json new file mode 100644 index 000000000000..b0e47a4208e1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSshAuthentication.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithTerminateScheduledEventEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithTerminateScheduledEventEnabled.json new file mode 100644 index 000000000000..0f9bd11877bd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithTerminateScheduledEventEnabled.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT5M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT5M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT5M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json new file mode 100644 index 000000000000..050c9fe3e3c3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2s_v3" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows10-tvm", + "publisher": "MicrosoftWindowsServer", + "version": "18363.592.2001092016", + "offer": "windowsserver-gen2preview-preview" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "TrustedLaunch" + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2s_v3" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows10-tvm", + "publisher": "MicrosoftWindowsServer", + "version": "18363.592.2001092016", + "offer": "windowsserver-gen2preview-preview" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "TrustedLaunch" + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2s_v3" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows10-tvm", + "publisher": "MicrosoftWindowsServer", + "version": "18363.592.2001092016", + "offer": "windowsserver-gen2preview-preview" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "TrustedLaunch" + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUserData.json new file mode 100644 index 000000000000..59ff220c2e9d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUserData.json @@ -0,0 +1,228 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "upgradePolicy": { + "mode": "Manual" + }, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMSizeProperties.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMSizeProperties.json new file mode 100644 index 000000000000..d23b00e4553d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMSizeProperties.json @@ -0,0 +1,246 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "upgradePolicy": { + "mode": "Manual" + }, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 1, + "vCPUsPerCore": 1 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMsInDifferentZones.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMsInDifferentZones.json new file mode 100644 index 000000000000..be3f03fd4dfd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMsInDifferentZones.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2023-09-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "location": "centralus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + } + }, + "zones": [ + "1", + "3" + ] + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "zoneBalance": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + }, + "provisioningState": "Succeeded" + }, + "zones": [ + "1", + "3" + ], + "location": "centralus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "zoneBalance": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + }, + "provisioningState": "Creating" + }, + "zones": [ + "1", + "3" + ], + "location": "centralus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MaximumSet_Gen.json new file mode 100644 index 000000000000..ca33a0138594 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaa" + ] + }, + "hibernate": true, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MinimumSet_Gen.json new file mode 100644 index 000000000000..3149d8b1fba0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MaximumSet_Gen.json new file mode 100644 index 000000000000..94b94cb242ea --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "forceDeletion": true, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MinimumSet_Gen.json new file mode 100644 index 000000000000..bda73b00ba44 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Delete_Force.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Delete_Force.json new file mode 100644 index 000000000000..7ff993ad18df --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Delete_Force.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "forceDeletion": "true", + "api-version": "2023-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/westus/operations/{operationId}&monitor=true&api-version=2023-09-01" + } + }, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen.json new file mode 100644 index 000000000000..b9d9560a592b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}", + "platformUpdateDomain": 30 + }, + "responses": { + "200": { + "body": { + "walkPerformed": true, + "nextPlatformUpdateDomain": 7 + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen.json new file mode 100644 index 000000000000..8ecf30f59ecf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}", + "platformUpdateDomain": 9 + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json new file mode 100644 index 000000000000..77abc1241dcb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "name": "myVirtualMachineScaleSet", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "sku": { + "name": "Standard_D2s_v3", + "tier": "Standard", + "capacity": 4 + }, + "etag": "\"1\"", + "properties": { + "singlePlacementGroup": false, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": false + } + }, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "diskSizeGB": 30 + }, + "imageReference": { + "publisher": "azuredatabricks", + "offer": "databricks", + "sku": "databricksworker", + "version": "3.15.2" + }, + "dataDisks": [] + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config" + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "osProfile": { + "computerNamePrefix": "myVirtualMachineScaleSet", + "adminUsername": "admin", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "myNic", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "myIPConfig", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet" + } + } + } + ], + "networkSecurityGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup" + } + } + } + ] + }, + "timeCreated": "2023-09-27T01:03:40.3138469+00:00" + }, + "provisioningState": "succeeded", + "overprovision": false, + "doNotRunExtensionsOnOverprovisionedVMs": false, + "platformFaultDomainCount": 1, + "hostGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup" + }, + "timeCreated": "2021-06-27T01:02:38.3138469+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json new file mode 100644 index 000000000000..7736b4f76043 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "virtualMachine": { + "statusesSummary": [ + { + "code": "aa", + "count": 21 + } + ] + }, + "extensions": [ + { + "name": "aaaaaaaaaaa", + "statusesSummary": [ + { + "code": "aa", + "count": 21 + } + ] + } + ], + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "aaaaaaaaaaaaaaaaaaaaaaa", + "time": "2021-11-30T12:58:26.526Z" + } + ], + "orchestrationServices": [ + { + "serviceName": "AutomaticRepairs", + "serviceState": "NotRunning" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json new file mode 100644 index 000000000000..a77d1978e573 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.json new file mode 100644 index 000000000000..59bcd82a03eb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "runningStatus": { + "code": "RollingForward", + "startTime": "2021-11-30T13:05:40.442Z", + "endTime": "2021-11-30T13:05:40.443Z" + }, + "progress": { + "successfulInstanceCount": 6, + "failedInstanceCount": 25, + "inProgressInstanceCount": 20, + "pendingInstanceCount": 27 + }, + "error": { + "details": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaa", + "target": "aaaa", + "message": "aa" + } + ], + "innererror": { + "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaa" + }, + "code": "aaaaaaa", + "target": "aaaaaaa", + "message": "aaaaaaaaa" + }, + "startedBy": "Unknown", + "targetImageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer", + "exactVersion": "aaaaaaa", + "sharedGalleryImageId": "aaaaaa", + "id": "aaaaaaaaaaaaaaaaaaa" + }, + "rollbackInfo": { + "successfullyRolledbackInstanceCount": 12, + "failedRolledbackInstanceCount": 2, + "rollbackError": { + "details": [ + { + "code": "aaaaaaaaaaaaaaaaaaaaaaaa", + "target": "aaaa", + "message": "aa" + } + ], + "innererror": { + "exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "errordetail": "aaaaaaaaaaaaaaaaaaaaaaaa" + }, + "code": "aaaaaaa", + "target": "aaaaaaa", + "message": "aaaaaaaaa" + } + } + }, + "type": "aaaaaaaaaaaaaaaaaaa", + "location": "aaaaaaaaaaaaa" + } + ], + "nextLink": "aaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.json new file mode 100644 index 000000000000..f364b4aef768 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + {} + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..70c1c26f76bc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "name": "myVirtualMachineScaleSet", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "location": "West US", + "tags": { + "myTag1": "tagValue1" + }, + "sku": { + "name": "Standard_D2s_v3", + "tier": "Standard", + "capacity": 4 + }, + "properties": { + "singlePlacementGroup": false, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": false + } + }, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "diskSizeGB": 30 + }, + "imageReference": { + "publisher": "azuredatabricks", + "offer": "databricks", + "sku": "databricksworker", + "version": "3.15.2" + }, + "dataDisks": [] + }, + "osProfile": { + "computerNamePrefix": "myVirtualMachineScaleSet", + "adminUsername": "admin", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "myNic", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "myIPConfig", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet" + } + } + } + ], + "networkSecurityGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup" + } + } + } + ] + } + }, + "provisioningState": "succeeded", + "overprovision": false, + "doNotRunExtensionsOnOverprovisionedVMs": false, + "platformFaultDomainCount": 1, + "hostGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json new file mode 100644 index 000000000000..12327979d3f1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "api-version": "2023-09-01", + "$expand": "userData" + }, + "responses": { + "200": { + "body": { + "name": "myVirtualMachineScaleSet", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "sku": { + "name": "Standard_D2s_v3", + "tier": "Standard", + "capacity": 4 + }, + "properties": { + "singlePlacementGroup": false, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": false + } + }, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "diskSizeGB": 30 + }, + "imageReference": { + "publisher": "azuredatabricks", + "offer": "databricks", + "sku": "databricksworker", + "version": "3.15.2" + }, + "dataDisks": [], + "diskControllerType": "NVMe" + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config" + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "osProfile": { + "computerNamePrefix": "myVirtualMachineScaleSet", + "adminUsername": "admin", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "myNic", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "myIPConfig", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet" + } + } + } + ], + "networkSecurityGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup" + } + } + } + ] + } + }, + "provisioningState": "succeeded", + "overprovision": false, + "doNotRunExtensionsOnOverprovisionedVMs": false, + "platformFaultDomainCount": 1, + "hostGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json new file mode 100644 index 000000000000..dcd5b2cd7fc9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "api-version": "2023-09-01", + "$expand": "userData" + }, + "responses": { + "200": { + "body": { + "name": "myVirtualMachineScaleSet", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "location": "westus", + "tags": { + "myTag1": "tagValue1" + }, + "sku": { + "name": "Standard_D2s_v3", + "tier": "Standard", + "capacity": 4 + }, + "properties": { + "singlePlacementGroup": false, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": false + } + }, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "diskSizeGB": 30 + }, + "imageReference": { + "publisher": "azuredatabricks", + "offer": "databricks", + "sku": "databricksworker", + "version": "3.15.2" + }, + "dataDisks": [] + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "myTag1", + "order": 1, + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/providers/Microsoft.Compute/galleries/myGallery1/applications/MyApplication1/versions/1.0", + "configurationReference": "https://mystorageaccount.blob.core.windows.net/configurations/settings.config" + }, + { + "packageReferenceId": "/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/providers/Microsoft.Compute/galleries/myGallery2/applications/MyApplication2/versions/1.1" + } + ] + }, + "userData": "RXhhbXBsZSBVc2VyRGF0YQ==", + "osProfile": { + "computerNamePrefix": "myVirtualMachineScaleSet", + "adminUsername": "admin", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "myNic", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "myIPConfig", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet" + } + } + } + ], + "networkSecurityGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup" + } + } + } + ] + } + }, + "provisioningState": "succeeded", + "overprovision": false, + "doNotRunExtensionsOnOverprovisionedVMs": false, + "platformFaultDomainCount": 1, + "hostGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MaximumSet_Gen.json new file mode 100644 index 000000000000..b2e8b15ed62b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MaximumSet_Gen.json @@ -0,0 +1,370 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer", + "exactVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaa", + "id": "a" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "createOption": "FromImage", + "name": "aaaaaaaaaaaaaaa", + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 30, + "osType": "Windows", + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "vhdContainers": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "dataDisks": [ + { + "name": "aaaaaaaaaaaaaa", + "lun": 24, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 11, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskIOPSReadWrite": 11, + "diskMBpsReadWrite": 13 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "customData": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaa", + "keyData": "aaaaaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "aaaaaaa", + "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + ] + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 18, + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaa", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "enableAcceleratedNetworking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "dnsSettings": { + "dnsServers": [ + "aaaaaaaaaaaa" + ] + }, + "deleteOption": "Delete" + } + } + ], + "healthProbe": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57" + }, + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaaaaaaaa" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "aa", + "type": "aaaaa", + "properties": { + "forceUpdateTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaa", + "type": "aaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisioningState": "aaaaaaaaaaaaaa", + "provisionAfterExtensions": [ + "aaaaaaaaaaaaaa" + ], + "suppressFailures": true + }, + "id": "aaaaaaaaaaaaaaaaaaaaaa" + } + ], + "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "licenseType": "aaaaaaaaaa", + "priority": "Regular", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": 4 + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "aa", + "enable": true + } + }, + "userData": "aaa", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "aaaaaaaaaaa", + "order": 29, + "packageReferenceId": "aaaaaaaaaa", + "configurationReference": "aaaaa" + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual", + "rollingUpgradePolicy": { + "maxBatchInstancePercent": 49, + "maxUnhealthyInstancePercent": 81, + "maxUnhealthyUpgradedInstancePercent": 98, + "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa", + "enableCrossZoneUpgrade": true, + "prioritizeUnhealthyInstances": true, + "rollbackFailedInstancesOnPolicyBreach": true, + "maxSurge": true + }, + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true, + "disableAutomaticRollback": true, + "osRollingUpgradeDeferral": true + } + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "aaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "provisioningState": "succeeded", + "doNotRunExtensionsOnOverprovisionedVMs": true, + "uniqueId": "aaaaaaaa", + "singlePlacementGroup": true, + "zoneBalance": true, + "platformFaultDomainCount": 1, + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hostGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "scaleInPolicy": { + "rules": [ + "Default" + ], + "forceDeletion": true + }, + "orchestrationMode": "Uniform", + "spotRestorePolicy": { + "enabled": true, + "restoreTimeout": "aaaaaaaaaa" + } + }, + "plan": { + "name": "aaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaaaaaaaa" + }, + "identity": { + "principalId": "aaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaa", + "type": "SystemAssigned", + "userAssignedIdentities": { + "key3951": { + "principalId": "aaaa", + "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "zones": [ + "aaaaaaaaaaaaaaaaaaaa" + ], + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}", + "name": "{virtualMachineScaleSetName}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "tags": { + "key8425": "aaa" + } + } + ], + "nextLink": "aaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MinimumSet_Gen.json new file mode 100644 index 000000000000..a74c23c25678 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListBySubscription_ByLocation.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListBySubscription_ByLocation.json new file mode 100644 index 000000000000..053994fff7a9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListBySubscription_ByLocation.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "eastus", + "api-version": "2023-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{virtualMachineScaleSetName}", + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "location": "eastus", + "tags": { + "myTag1": "tagValue1" + }, + "sku": { + "name": "Standard_D2s_v3", + "tier": "Standard", + "capacity": 4 + }, + "properties": { + "singlePlacementGroup": false, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": false + } + }, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "diskSizeGB": 30 + }, + "imageReference": { + "publisher": "azuredatabricks", + "offer": "databricks", + "sku": "databricksworker", + "version": "3.15.2" + }, + "dataDisks": [] + }, + "osProfile": { + "computerNamePrefix": "{virtualMachineScaleSetName}", + "adminUsername": "admin", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "myNic", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "myIPConfig", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet" + } + } + } + ], + "networkSecurityGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup" + } + } + } + ] + } + }, + "provisioningState": "succeeded", + "overprovision": false, + "doNotRunExtensionsOnOverprovisionedVMs": false, + "platformFaultDomainCount": 1 + } + }, + { + "name": "{virtualMachineScaleSetName}", + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}1", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "location": "eastus", + "tags": { + "myTag1": "tagValue2" + }, + "sku": { + "name": "Standard_D2s_v3", + "tier": "Standard", + "capacity": 4 + }, + "properties": { + "singlePlacementGroup": false, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": false + } + }, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "diskSizeGB": 30 + }, + "imageReference": { + "publisher": "azuredatabricks", + "offer": "databricks", + "sku": "databricksworker", + "version": "3.15.2" + }, + "dataDisks": [] + }, + "osProfile": { + "computerNamePrefix": "{virtualMachineScaleSetName}", + "adminUsername": "admin", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "myNic1", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "myIPConfig", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet" + } + } + } + ], + "networkSecurityGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup" + } + } + } + ] + } + }, + "provisioningState": "succeeded", + "overprovision": false, + "doNotRunExtensionsOnOverprovisionedVMs": false, + "platformFaultDomainCount": 1 + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MaximumSet_Gen.json new file mode 100644 index 000000000000..c87570894da2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MaximumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "aaaaaaaaaaaaaaaaa", + "sku": { + "name": "DSv3-Type1", + "tier": "aaa", + "capacity": 7 + }, + "capacity": { + "minimum": 22, + "maximum": 27, + "defaultCapacity": 20, + "scaleType": "Automatic" + } + } + ], + "nextLink": "aaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MinimumSet_Gen.json new file mode 100644 index 000000000000..a7afe9d7f9dd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + {} + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..49aefb3ef1c7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MaximumSet_Gen.json @@ -0,0 +1,687 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{virtualMachineScaleSetName}", + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "location": "eastus", + "tags": {}, + "sku": { + "name": "Standard_D2s_v3", + "tier": "Standard", + "capacity": 4 + }, + "properties": { + "singlePlacementGroup": true, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true, + "disableAutomaticRollback": true, + "useRollingUpgradePolicy": true, + "osRollingUpgradeDeferral": true + }, + "rollingUpgradePolicy": { + "maxBatchInstancePercent": 49, + "maxUnhealthyInstancePercent": 81, + "maxUnhealthyUpgradedInstancePercent": 98, + "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa", + "enableCrossZoneUpgrade": true, + "prioritizeUnhealthyInstances": true, + "rollbackFailedInstancesOnPolicyBreach": true, + "maxSurge": true + } + }, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskSizeGB": 30, + "name": "aaaaaaaaaaaaaaaaaaaaaaa", + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "osType": "Windows", + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "vhdContainers": [ + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "imageReference": { + "publisher": "azuredatabricks", + "offer": "databricks", + "sku": "databricksworker", + "version": "3.15.2", + "exactVersion": "aaaaaaaaaaaaaaaaaaaaaaa", + "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaa", + "id": "aaaaaaaaaa" + }, + "dataDisks": [] + }, + "osProfile": { + "computerNamePrefix": "{virtualMachineScaleSetName}", + "adminUsername": "admin", + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaa", + "keyData": "aaaaaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + }, + "customData": "aaaaaaaaaaaaaaaaaa", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "aaaaaaa", + "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + ] + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "myNic", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "myIPConfig", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet" + }, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 18, + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "networkSecurityGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup" + }, + "enableAcceleratedNetworking": true, + "enableFpga": true, + "dnsSettings": { + "dnsServers": [ + "aaaaaaaaaaaa" + ] + }, + "enableIPForwarding": true, + "deleteOption": "Delete" + } + } + ], + "healthProbe": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57" + }, + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaaaaaaaa" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "aa", + "type": "aaaaa", + "properties": { + "forceUpdateTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaa", + "type": "aaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisioningState": "aaaaaaaaaaaaaa", + "provisionAfterExtensions": [ + "aaaaaaaaaaaaaa" + ], + "suppressFailures": true + }, + "id": "aaaaaaaaaaaaaaaaaaaaaa" + } + ], + "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "licenseType": "aaaa", + "priority": "Regular", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": 4 + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "aa", + "enable": true + } + }, + "userData": "aaaaaaaaaaaaaaaaaaaaaaaaa", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "aaaaaaaaaaa", + "order": 29, + "packageReferenceId": "aaaaaaaaaa", + "configurationReference": "aaaaa" + } + ] + } + }, + "provisioningState": "succeeded", + "overprovision": true, + "doNotRunExtensionsOnOverprovisionedVMs": true, + "platformFaultDomainCount": 1, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "aaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "uniqueId": "aaaaaaaaaaaaaaaaaaaaaaa", + "zoneBalance": true, + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hostGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "scaleInPolicy": { + "rules": [ + "Default" + ], + "forceDeletion": true + }, + "orchestrationMode": "Uniform", + "spotRestorePolicy": { + "enabled": true, + "restoreTimeout": "aaaaaaaaaa" + } + }, + "plan": { + "name": "aaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaaaaaaaa" + }, + "identity": { + "principalId": "aaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaa", + "type": "SystemAssigned", + "userAssignedIdentities": { + "key3951": { + "principalId": "aaaa", + "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "zones": [ + "aaaaaaa" + ], + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + } + }, + { + "name": "{virtualMachineScaleSetName}", + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}1", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "location": "eastus", + "tags": {}, + "sku": { + "name": "Standard_D2s_v3", + "tier": "Standard", + "capacity": 4 + }, + "properties": { + "singlePlacementGroup": true, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true, + "disableAutomaticRollback": true, + "useRollingUpgradePolicy": true, + "osRollingUpgradeDeferral": true + }, + "rollingUpgradePolicy": { + "maxBatchInstancePercent": 49, + "maxUnhealthyInstancePercent": 81, + "maxUnhealthyUpgradedInstancePercent": 98, + "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa", + "enableCrossZoneUpgrade": true, + "prioritizeUnhealthyInstances": true, + "maxSurge": true + } + }, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskSizeGB": 30, + "name": "a", + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "osType": "Windows", + "image": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "vhdContainers": [ + "aaaaaaaaaaaaaaaa" + ] + }, + "imageReference": { + "publisher": "azuredatabricks", + "offer": "databricks", + "sku": "databricksworker", + "version": "3.15.2", + "exactVersion": "aa", + "sharedGalleryImageId": "aaaaaaa", + "id": "aaa" + }, + "dataDisks": [] + }, + "osProfile": { + "computerNamePrefix": "{virtualMachineScaleSetName}", + "adminUsername": "admin", + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "aaa", + "keyData": "aaaaaa" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + }, + "customData": "a", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault" + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "aaaaaaa", + "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + ] + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "myNic1", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "myIPConfig", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet" + }, + "publicIPAddressConfiguration": { + "name": "aaaaaaaaaaaaaaaaaa", + "properties": { + "idleTimeoutInMinutes": 18, + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + ] + } + } + ], + "networkSecurityGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup" + }, + "enableAcceleratedNetworking": true, + "enableFpga": true, + "dnsSettings": { + "dnsServers": [ + "aaaaaaaaaaaa" + ] + }, + "enableIPForwarding": true, + "deleteOption": "Delete" + } + } + ], + "healthProbe": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/restorePointCollections/rpcName/restorePoints/restorePointName/diskRestorePoints/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f_22b4bdfe-6c54-4f72-84d8-85d8860f0c57" + }, + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "aaaaaaaaaaaaaaaaaaa" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "aa", + "type": "aaaaa", + "properties": { + "forceUpdateTag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "publisher": "aaaaaaaaaaaaa", + "type": "aaaaaaaa", + "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaa", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisioningState": "aaaaaaaaaaaaaa", + "provisionAfterExtensions": [ + "aaaaaaaaaaaaaa" + ], + "suppressFailures": true + }, + "id": "aaaaaaaaaaaaaaaaaaaaaa" + } + ], + "extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "licenseType": "aaaaaaaaaaaaaaaaaaaaaaa", + "priority": "Regular", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": 4 + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "aa", + "enable": true + } + }, + "userData": "aaaaaaaaaaaaaaaaaaaaaa", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "aaaaaaaaaaa", + "order": 29, + "packageReferenceId": "aaaaaaaaaa", + "configurationReference": "aaaaa" + } + ] + } + }, + "provisioningState": "succeeded", + "overprovision": true, + "doNotRunExtensionsOnOverprovisionedVMs": true, + "platformFaultDomainCount": 1, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "aaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "uniqueId": "aaaaa", + "zoneBalance": true, + "proximityPlacementGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hostGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "scaleInPolicy": { + "rules": [ + "Default" + ], + "forceDeletion": true + }, + "orchestrationMode": "Uniform", + "spotRestorePolicy": { + "enabled": true, + "restoreTimeout": "aaaaaaaaaa" + } + }, + "plan": { + "name": "aaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaaaaaaaa" + }, + "identity": { + "principalId": "aaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaa", + "type": "SystemAssigned", + "userAssignedIdentities": { + "key3951": { + "principalId": "aaaa", + "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "zones": [ + "aaaaaaaa" + ], + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + } + } + ], + "nextLink": "aaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..35e0167ccae5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}" + }, + { + "location": "eastus", + "id": "/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MaximumSet_Gen.json new file mode 100644 index 000000000000..200d3ce05d98 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaa" + ] + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MinimumSet_Gen.json new file mode 100644 index 000000000000..69aa23a88498 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MaximumSet_Gen.json new file mode 100644 index 000000000000..d56c36de93b3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaa" + ] + }, + "skipShutdown": true, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MinimumSet_Gen.json new file mode 100644 index 000000000000..33d1953e72d9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "a", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MaximumSet_Gen.json new file mode 100644 index 000000000000..c47dca2c40ff --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "VirtualMachineScaleSetReapplyTestRG", + "vmScaleSetName": "VMSSReapply-Test-ScaleSet", + "api-version": "2023-09-01", + "subscriptionId": "b4f1213b-cacc-4816-8bfb-f30f90643de8" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/b4f1213b-cacc-4816-8bfb-f30f90643de8/providers/Microsoft.Compute/locations/eastus/operationResults/c57dff56-0cd2-4e24-8d11-4e18d77f7e85?api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MinimumSet_Gen.json new file mode 100644 index 000000000000..c47dca2c40ff --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "VirtualMachineScaleSetReapplyTestRG", + "vmScaleSetName": "VMSSReapply-Test-ScaleSet", + "api-version": "2023-09-01", + "subscriptionId": "b4f1213b-cacc-4816-8bfb-f30f90643de8" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/b4f1213b-cacc-4816-8bfb-f30f90643de8/providers/Microsoft.Compute/locations/eastus/operationResults/c57dff56-0cd2-4e24-8d11-4e18d77f7e85?api-version=2023-09-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MaximumSet_Gen.json new file mode 100644 index 000000000000..fdb4df773555 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaa" + ] + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MinimumSet_Gen.json new file mode 100644 index 000000000000..8e52cb110bf7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MaximumSet_Gen.json new file mode 100644 index 000000000000..c529319baa9d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaa" + ] + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MinimumSet_Gen.json new file mode 100644 index 000000000000..8e52cb110bf7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json new file mode 100644 index 000000000000..9efddb03daa5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmScaleSetReimageInput": { + "instanceIds": [ + "aaaaaaaaaa" + ], + "tempDisk": true + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json new file mode 100644 index 000000000000..c6881d3f16a6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MaximumSet_Gen.json new file mode 100644 index 000000000000..09a34a961042 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaa" + ] + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MinimumSet_Gen.json new file mode 100644 index 000000000000..d3c921e5e255 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen.json new file mode 100644 index 000000000000..79e589d8c7b9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaa", + "parameters": { + "serviceName": "AutomaticRepairs", + "action": "Resume" + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen.json new file mode 100644 index 000000000000..a74a8615b381 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "parameters": { + "serviceName": "AutomaticRepairs", + "action": "Resume" + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MaximumSet_Gen.json new file mode 100644 index 000000000000..d207c862d962 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaa" + ] + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MinimumSet_Gen.json new file mode 100644 index 000000000000..b6be28e4f7f8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaa", + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MaximumSet_Gen.json new file mode 100644 index 000000000000..d833c5818464 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MaximumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MinimumSet_Gen.json new file mode 100644 index 000000000000..1e2af49c3006 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "vmInstanceIDs": { + "instanceIds": [ + "aaaaaaaaaaaaaaaaaaaaaaaaa" + ] + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MaximumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..105baa966242 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MaximumSet_Gen.json @@ -0,0 +1,651 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaa", + "parameters": { + "sku": { + "name": "DSv3-Type1", + "tier": "aaa", + "capacity": 7 + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016", + "promotionCode": "aaaaaaaaaa" + }, + "properties": { + "upgradePolicy": { + "mode": "Manual", + "rollingUpgradePolicy": { + "maxBatchInstancePercent": 49, + "maxUnhealthyInstancePercent": 81, + "maxUnhealthyUpgradedInstancePercent": 98, + "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa", + "enableCrossZoneUpgrade": true, + "prioritizeUnhealthyInstances": true, + "rollbackFailedInstancesOnPolicyBreach": true, + "maxSurge": true + }, + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true, + "disableAutomaticRollback": true, + "osRollingUpgradeDeferral": true + } + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + }, + "virtualMachineProfile": { + "osProfile": { + "customData": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Never" + } + }, + "timeZone": "aaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "aaaaaaa", + "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer", + "sharedGalleryImageId": "aaaaaa", + "id": "aaaaaaaaaaaaaaaaaaa" + }, + "osDisk": { + "caching": "ReadWrite", + "writeAcceleratorEnabled": true, + "diskSizeGB": 6, + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + }, + "vhdContainers": [ + "aa" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + } + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 26, + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "caching": "None", + "writeAcceleratorEnabled": true, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskIOPSReadWrite": 28, + "diskMBpsReadWrite": 15 + } + ] + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123" + }, + "networkInterfaceConfigurations": [ + { + "name": "aaaaaaaa", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "dnsSettings": { + "dnsServers": [] + }, + "ipConfigurations": [ + { + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "a", + "properties": { + "idleTimeoutInMinutes": 3, + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaa" + }, + "deleteOption": "Delete" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + ], + "applicationSecurityGroups": [ + { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "encryptionAtHost": true, + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "securityType": "TrustedLaunch" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {}, + "forceUpdateTag": "aaaaaaaaa", + "enableAutomaticUpgrade": true, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "aa" + ], + "suppressFailures": true + } + } + ], + "extensionsTimeBudget": "PT1H20M" + }, + "licenseType": "aaaaaaaaaaaa", + "billingProfile": { + "maxPrice": -1 + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "PT10M", + "enable": true + } + }, + "userData": "aaaaaaaaaaaaa" + }, + "overprovision": true, + "doNotRunExtensionsOnOverprovisionedVMs": true, + "singlePlacementGroup": true, + "additionalCapabilities": { + "hibernationEnabled": true, + "ultraSSDEnabled": true + }, + "scaleInPolicy": { + "rules": [ + "OldestVM" + ], + "forceDeletion": true + }, + "proximityPlacementGroup": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + }, + "identity": { + "type": "SystemAssigned", + "userAssignedIdentities": { + "key3951": {} + } + }, + "tags": { + "key246": "aaaaaaaaaaaaaaaaaaaaaaaa" + } + }, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer", + "exactVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "sharedGalleryImageId": "aaaaaa", + "id": "aaaaaaaaaaaaaaaaaaa" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "createOption": "FromImage", + "name": "aaaaaaaaaaaaaaa", + "writeAcceleratorEnabled": true, + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 6, + "osType": "Windows", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + }, + "vhdContainers": [ + "aa" + ] + }, + "dataDisks": [ + { + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "lun": 26, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "Empty", + "diskSizeGB": 1023, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "aaaaaaaaaaaa" + } + }, + "diskIOPSReadWrite": 28, + "diskMBpsReadWrite": 15 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "customData": "aaaaaaaaaaaaaaaaaaaaaaaaaa", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "aaaaaaaaaaaaaaaa", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "aaaaaaaaaaaaaaaaaaaa" + } + ], + "patchSettings": { + "patchMode": "AutomaticByPlatform", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Never" + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault" + } + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "aaaaaaa", + "certificateStore": "aaaaaaaaaaaaaaaaaaaaaaaaa" + } + ] + } + ] + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "aaaaaaaa", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "a", + "properties": { + "idleTimeoutInMinutes": 3, + "dnsSettings": { + "domainNameLabel": "aaaaaaaaaaaaaaaaaa" + }, + "ipTags": [ + { + "ipTagType": "aaaaaaa", + "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + ], + "applicationSecurityGroups": [ + { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + ] + } + } + ], + "enableAcceleratedNetworking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "dnsSettings": { + "dnsServers": [ + "aaaaaaaaaaaa" + ] + }, + "deleteOption": "Delete" + } + } + ], + "healthProbe": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/disk123" + }, + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "type": "aaaaa", + "properties": { + "forceUpdateTag": "aaaaaaaaa", + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisioningState": "aaaaaaaaaaaaaa", + "provisionAfterExtensions": [ + "aa" + ], + "suppressFailures": true + }, + "id": "aaaaaaaaaaaaaaaaaaaaaa" + } + ], + "extensionsTimeBudget": "PT1H20M" + }, + "licenseType": "aaaaaaaaaaaa", + "priority": "Regular", + "evictionPolicy": "Deallocate", + "billingProfile": { + "maxPrice": -1 + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "PT10M", + "enable": true + } + }, + "userData": "aaaaaaaaaaaaa", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "aaaaaaaaaaa", + "order": 29, + "packageReferenceId": "aaaaaaaaaa", + "configurationReference": "aaaaa" + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual", + "rollingUpgradePolicy": { + "maxBatchInstancePercent": 49, + "maxUnhealthyInstancePercent": 81, + "maxUnhealthyUpgradedInstancePercent": 98, + "pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa", + "enableCrossZoneUpgrade": true, + "prioritizeUnhealthyInstances": true, + "maxSurge": true + }, + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true, + "disableAutomaticRollback": true, + "osRollingUpgradeDeferral": true + } + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + }, + "provisioningState": "succeeded", + "doNotRunExtensionsOnOverprovisionedVMs": true, + "uniqueId": "aaaaaaaa", + "singlePlacementGroup": true, + "zoneBalance": true, + "platformFaultDomainCount": 1, + "proximityPlacementGroup": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "hostGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "additionalCapabilities": { + "ultraSSDEnabled": true, + "hibernationEnabled": true + }, + "scaleInPolicy": { + "rules": [ + "OldestVM" + ], + "forceDeletion": true + }, + "orchestrationMode": "Uniform", + "spotRestorePolicy": { + "enabled": true, + "restoreTimeout": "aaaaaaaaaa" + } + }, + "plan": { + "name": "aaaaaaaaaa", + "publisher": "aaaaaaaaaaaaaaaaaaaaaa", + "product": "aaaaaaaaaaaaaaaaaaaa", + "promotionCode": "aaaaaaaaaaaaaaaaaaaa" + }, + "identity": { + "principalId": "aaaaaaaaaaaaaaa", + "tenantId": "aaaaaaaaaaaaaaaa", + "type": "SystemAssigned", + "userAssignedIdentities": { + "key3951": { + "principalId": "aaaa", + "clientId": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + }, + "zones": [ + "aaaaaaaaaaaaaaaaaaaa" + ], + "extendedLocation": { + "name": "aaaaaaaaaaaaaaaaaaaaa", + "type": "EdgeZone" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}", + "name": "{virtualMachineScaleSetName}", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "tags": { + "key8425": "aaa" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MinimumSet_Gen.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..bf7c302b578c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MinimumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "resourceGroupName": "rgcompute", + "vmScaleSetName": "aaaaaaaaaaaaaa", + "parameters": {}, + "api-version": "2023-09-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/image.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/image.json new file mode 100644 index 000000000000..dfa6615d36a7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/image.json @@ -0,0 +1,597 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}": { + "put": { + "tags": [ + "Images" + ], + "operationId": "Images_CreateOrUpdate", + "description": "Create or update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + }, + "description": "Parameters supplied to the Create Image operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a virtual machine image from a blob.": { + "$ref": "./examples/imageExamples/Image_CreateFromABlob.json" + }, + "Create a virtual machine image from a snapshot.": { + "$ref": "./examples/imageExamples/Image_CreateFromASnapshot.json" + }, + "Create a virtual machine image from a managed disk.": { + "$ref": "./examples/imageExamples/Image_CreateFromAManagedDisk.json" + }, + "Create a virtual machine image from an existing virtual machine.": { + "$ref": "./examples/imageExamples/Image_CreateFromAVM.json" + }, + "Create a virtual machine image that includes a data disk from a blob.": { + "$ref": "./examples/imageExamples/Image_Create_DataDiskFromABlobIncluded.json" + }, + "Create a virtual machine image that includes a data disk from a snapshot.": { + "$ref": "./examples/imageExamples/Image_Create_DataDiskFromASnapshotIncluded.json" + }, + "Create a virtual machine image that includes a data disk from a managed disk.": { + "$ref": "./examples/imageExamples/Image_Create_DataDiskFromAManagedDiskIncluded.json" + }, + "Create a virtual machine image from a blob with DiskEncryptionSet resource.": { + "$ref": "./examples/imageExamples/Image_CreateFromABlobWithDiskEncryptionSet.json" + }, + "Create a virtual machine image from a snapshot with DiskEncryptionSet resource.": { + "$ref": "./examples/imageExamples/Image_CreateFromASnapshotWithDiskEncryptionSet.json" + }, + "Create a virtual machine image from a managed disk with DiskEncryptionSet resource.": { + "$ref": "./examples/imageExamples/Image_CreateFromAManagedDiskWithDiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Images" + ], + "operationId": "Images_Update", + "description": "Update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUpdate" + }, + "description": "Parameters supplied to the Update Image operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates tags of an Image.": { + "$ref": "./examples/imageExamples/Image_Update.json" + } + } + }, + "delete": { + "tags": [ + "Images" + ], + "operationId": "Images_Delete", + "description": "Deletes an Image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Image_Delete_MaximumSet_Gen": { + "$ref": "./examples/imageExamples/Images_Delete_MaximumSet_Gen.json" + }, + "Image_Delete_MinimumSet_Gen": { + "$ref": "./examples/imageExamples/Images_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_Get", + "description": "Gets an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "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 virtual machine image.": { + "$ref": "./examples/imageExamples/Image_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_ListByResourceGroup", + "description": "Gets the list of images under a resource group. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a resource group.": { + "$ref": "./examples/imageExamples/Image_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_List", + "description": "Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a subscription.": { + "$ref": "./examples/imageExamples/Image_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ImageOSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "The OS State. For managed images, use Generalized.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false, + "values": [ + { + "value": "Generalized", + "description": "Generalized image. Needs to be provisioned during deployment time." + }, + { + "value": "Specialized", + "description": "Specialized image. Contains already provisioned OS Disk." + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageDisk" + } + ], + "required": [ + "osType", + "osState" + ], + "description": "Describes an Operating System disk." + }, + "ImageDataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageDisk" + } + ], + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageDisk": { + "properties": { + "snapshot": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB." + }, + "storageAccountType": { + "$ref": "./computeRPCommon.json#/definitions/StorageAccountType", + "description": "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." + }, + "diskEncryptionSet": { + "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed image disk." + } + }, + "description": "Describes a image disk." + }, + "ImageStorageProfile": { + "properties": { + "osDisk": { + "$ref": "#/definitions/ImageOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "zoneResilient": { + "type": "boolean", + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + } + }, + "description": "Describes a storage profile." + }, + "ImageProperties": { + "properties": { + "sourceVirtualMachine": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The source virtual machine from which Image is created." + }, + "storageProfile": { + "$ref": "#/definitions/ImageStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state." + }, + "hyperVGeneration": { + "$ref": "./computeRPCommon.json#/definitions/HyperVGenerationType", + "description": "Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource." + } + }, + "description": "Describes the properties of an Image." + }, + "Image": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location of the Image." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "ImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "The source user image virtual hard disk. Only tags may be updated." + }, + "ImageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "description": "The list of Images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images." + } + }, + "required": [ + "value" + ], + "description": "The List Image operation response." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/logAnalytic.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/logAnalytic.json new file mode 100644 index 000000000000..752db1b7c839 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/logAnalytic.json @@ -0,0 +1,259 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportRequestRateByInterval", + "x-ms-examples": { + "Export logs which contain all Api requests made to Compute Resource Provider within the given time period broken down by intervals.": { + "$ref": "./examples/logAnalyticExamples/LogAnalytics_RequestRateByInterval.json" + } + }, + "description": "Export logs that show Api requests made by this subscription in the given time window to show throttling activities.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RequestRateByIntervalInput" + }, + "description": "Parameters supplied to the LogAnalytics getRequestRateByInterval Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "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": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportThrottledRequests", + "x-ms-examples": { + "Export logs which contain all throttled Api requests made to Compute Resource Provider within the given time period.": { + "$ref": "./examples/logAnalyticExamples/LogAnalytics_ThrottledRequests.json" + } + }, + "description": "Export logs that show total throttled Api requests for this subscription in the given time window.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThrottledRequestsInput" + }, + "description": "Parameters supplied to the LogAnalytics getThrottledRequests Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "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": "azure-async-operation" + } + } + } + }, + "definitions": { + "RequestRateByIntervalInput": { + "properties": { + "intervalLength": { + "type": "string", + "description": "Interval value in minutes used to create LogAnalytics call rate logs.", + "enum": [ + "ThreeMins", + "FiveMins", + "ThirtyMins", + "SixtyMins" + ], + "x-ms-enum": { + "name": "IntervalInMins", + "modelAsString": false + } + } + }, + "required": [ + "intervalLength" + ], + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getRequestRateByInterval Api." + }, + "ThrottledRequestsInput": { + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getThrottledRequests Api." + }, + "LogAnalyticsInputBase": { + "properties": { + "blobContainerSasUri": { + "type": "string", + "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to." + }, + "fromTime": { + "type": "string", + "format": "date-time", + "description": "From time of the query" + }, + "toTime": { + "type": "string", + "format": "date-time", + "description": "To time of the query" + }, + "groupByThrottlePolicy": { + "type": "boolean", + "description": "Group query result by Throttle Policy applied." + }, + "groupByOperationName": { + "type": "boolean", + "description": "Group query result by Operation Name." + }, + "groupByResourceName": { + "type": "boolean", + "description": "Group query result by Resource Name." + }, + "groupByClientApplicationId": { + "type": "boolean", + "description": "Group query result by Client Application ID." + }, + "groupByUserAgent": { + "type": "boolean", + "description": "Group query result by User Agent." + } + }, + "required": [ + "blobContainerSasUri", + "fromTime", + "toTime" + ], + "description": "Api input base class for LogAnalytics Api." + }, + "LogAnalyticsOperationResult": { + "properties": { + "properties": { + "readOnly": true, + "$ref": "#/definitions/LogAnalyticsOutput", + "description": "LogAnalyticsOutput" + } + }, + "description": "LogAnalytics operation status response" + }, + "LogAnalyticsOutput": { + "properties": { + "output": { + "readOnly": true, + "type": "string", + "description": "Output file Uri path to blob container." + } + }, + "description": "LogAnalytics output properties" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/proximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/proximityPlacementGroup.json new file mode 100644 index 000000000000..f30264e66a87 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/proximityPlacementGroup.json @@ -0,0 +1,455 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}": { + "put": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_CreateOrUpdate", + "description": "Create or update a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + }, + "description": "Parameters supplied to the Create Proximity Placement Group operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update a proximity placement group.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Update", + "description": "Update a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupUpdate" + }, + "description": "Parameters supplied to the Update Proximity Placement Group operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a proximity placement group.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Patch.json" + } + } + }, + "delete": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Delete", + "description": "Delete a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a proximity placement group.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Delete.json" + } + } + }, + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Get", + "description": "Retrieves information about a proximity placement group .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "includeColocationStatus", + "in": "query", + "required": false, + "type": "string", + "description": "includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get proximity placement groups.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListBySubscription", + "description": "Lists all proximity placement groups in a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List proximity placement groups.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListByResourceGroup", + "description": "Lists all proximity placement groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List proximity placement group.": { + "$ref": "./examples/proximityPlacementGroupExamples/ProximityPlacementGroup_ListByResourceGroup.json" + } + } + } + } + }, + "definitions": { + "ProximityPlacementGroupProperties": { + "properties": { + "proximityPlacementGroupType": { + "type": "string", + "description": "Specifies the type of the proximity placement group. Possible values are: **Standard** : Co-locate resources within an Azure region or Availability Zone. **Ultra** : For future use.", + "enum": [ + "Standard", + "Ultra" + ], + "x-ms-enum": { + "name": "ProximityPlacementGroupType", + "modelAsString": true + } + }, + "virtualMachines": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all virtual machines in the proximity placement group." + }, + "virtualMachineScaleSets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all virtual machine scale sets in the proximity placement group." + }, + "availabilitySets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all availability sets in the proximity placement group." + }, + "colocationStatus": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus", + "description": "Describes colocation status of the Proximity Placement Group." + }, + "intent": { + "type": "object", + "properties": { + "vmSizes": { + "type": "array", + "description": "Specifies possible sizes of virtual machines that can be created in the proximity placement group.", + "items": { + "type": "string", + "description": "Specifies the size of the virtual machine. Recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region]( https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set." + } + } + }, + "description": "Specifies the user intent of the proximity placement group." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, + "ProximityPlacementGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProximityPlacementGroupProperties", + "description": "Describes the properties of a Proximity Placement Group." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the Availability Zone where virtual machine, virtual machine scale set or availability set associated with the proximity placement group can be created." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupUpdate": { + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProximityPlacementGroup" + }, + "description": "The list of proximity placement groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of proximity placement groups." + } + }, + "required": [ + "value" + ], + "description": "The List Proximity Placement Group operation response." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/restorePoint.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/restorePoint.json new file mode 100644 index 000000000000..b39c49270053 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/restorePoint.json @@ -0,0 +1,1004 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}": { + "put": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_CreateOrUpdate", + "description": "The operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified.", + "x-ms-examples": { + "Create or update a restore point collection.": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_CreateOrUpdate.json" + }, + "Create or update a restore point collection for cross region copy.": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_CreateOrUpdate_ForCrossRegionCopy.json" + } + }, + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RestorePointCollection" + }, + "description": "Parameters supplied to the Create or Update restore point collection operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollection" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/RestorePointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_Update", + "description": "The operation to update the restore point collection.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RestorePointCollectionUpdate" + }, + "description": "Parameters supplied to the Update restore point collection operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "RestorePointCollection_Update_MaximumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Update_MaximumSet_Gen.json" + }, + "RestorePointCollection_Update_MinimumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_Delete", + "description": "The operation to delete the restore point collection. This operation will also delete all the contained restore points.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Restore Point Collection." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RestorePointCollection_Delete_MaximumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Delete_MaximumSet_Gen.json" + }, + "RestorePointCollection_Delete_MinimumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_Get", + "description": "The operation to get the restore point collection.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. If expand=restorePoints, server will return all contained restore points in the restorePointCollection.", + "enum": [ + "restorePoints" + ], + "x-ms-enum": { + "name": "RestorePointCollectionExpandOptions", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Get a restore point collection (but not the restore points contained in the restore point collection)": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Get.json" + }, + "Get a restore point collection, including the restore points contained in the restore point collection": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_Get_WithContainedRestorePoints.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections": { + "get": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_List", + "description": "Gets the list of restore point collections in a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Gets the list of restore point collections in a resource group.": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_ListByResourceGroup.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/restorePointCollections": { + "get": { + "tags": [ + "RestorePointCollections" + ], + "operationId": "RestorePointCollections_ListAll", + "description": "Gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePointCollectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets the list of restore point collections in a subscription": { + "$ref": "./examples/restorePointExamples/RestorePointCollection_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/restorePointCollections/{restorePointCollectionName}/restorePoints/{restorePointName}": { + "put": { + "operationId": "RestorePoints_Create", + "description": "The operation to create the restore point. Updating properties of an existing restore point is not allowed", + "x-ms-examples": { + "Create a restore point": { + "$ref": "./examples/restorePointExamples/RestorePoint_Create.json" + }, + "Copy a restore point to a different region": { + "$ref": "./examples/restorePointExamples/RestorePoint_Copy_BetweenRegions.json" + } + }, + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection." + }, + { + "name": "restorePointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RestorePoint" + }, + "description": "Parameters supplied to the Create restore point operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/RestorePoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RestorePoints_Delete", + "description": "The operation to delete the restore point.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Restore Point Collection." + }, + { + "name": "restorePointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RestorePoint_Delete_MaximumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePoint_Delete_MaximumSet_Gen.json" + }, + "RestorePoint_Delete_MinimumSet_Gen": { + "$ref": "./examples/restorePointExamples/RestorePoint_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "operationId": "RestorePoints_Get", + "description": "The operation to get the restore point.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "restorePointCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point collection." + }, + { + "name": "restorePointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the restore point." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "RestorePointExpandOptions", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-examples": { + "Get a restore point": { + "$ref": "./examples/restorePointExamples/RestorePoint_Get.json" + }, + "Get restore point with instance view": { + "$ref": "./examples/restorePointExamples/RestorePoint_Get_WithInstanceView.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestorePoint" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "RestorePointCollectionSourceProperties": { + "properties": { + "location": { + "type": "string", + "readOnly": true, + "description": "Location of the source resource used to create this restore point collection." + }, + "id": { + "type": "string", + "description": "Resource Id of the source resource used to create this restore point collection" + } + }, + "description": "The properties of the source resource that this restore point collection is created from." + }, + "RestorePointCollectionProperties": { + "properties": { + "source": { + "$ref": "#/definitions/RestorePointCollectionSourceProperties" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the restore point collection." + }, + "restorePointCollectionId": { + "type": "string", + "readOnly": true, + "description": "The unique id of the restore point collection." + }, + "restorePoints": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RestorePoint" + }, + "description": "A list containing all restore points created under this restore point collection." + } + }, + "description": "The restore point collection properties." + }, + "RestorePointCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestorePointCollectionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Create or update Restore Point collection parameters." + }, + "RestorePointCollectionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestorePointCollectionProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Update Restore Point collection parameters." + }, + "RestorePointCollectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RestorePointCollection" + }, + "description": "Gets the list of restore point collections." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of RestorePointCollections. Call ListNext() with this to fetch the next page of RestorePointCollections" + } + }, + "description": "The List restore point collection operation response." + }, + "RestorePointSourceMetadata": { + "properties": { + "hardwareProfile": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/HardwareProfile", + "description": "Gets the hardware profile." + }, + "storageProfile": { + "$ref": "#/definitions/RestorePointSourceVMStorageProfile", + "description": "Gets the storage profile." + }, + "osProfile": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/OSProfile", + "description": "Gets the OS profile." + }, + "diagnosticsProfile": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", + "description": "Gets the diagnostics profile." + }, + "licenseType": { + "type": "string", + "readOnly": true, + "description": "Gets the license type, which is for bring your own license scenario." + }, + "vmId": { + "type": "string", + "readOnly": true, + "description": "Gets the virtual machine unique id." + }, + "securityProfile": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", + "description": "Gets the security profile." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "Location of the VM from which the restore point was created." + }, + "userData": { + "type": "string", + "readOnly": true, + "description": "UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value." + }, + "hyperVGeneration": { + "$ref": "./computeRPCommon.json#/definitions/HyperVGenerationType", + "readOnly": true, + "description": "HyperVGeneration of the source VM for which restore point is captured." + } + }, + "description": "Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation." + }, + "RestorePointSourceVMStorageProfile": { + "properties": { + "osDisk": { + "$ref": "#/definitions/RestorePointSourceVMOSDisk", + "description": "Gets the OS disk of the VM captured at the time of the restore point creation." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/RestorePointSourceVMDataDisk" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "Gets the data disks of the VM captured at the time of the restore point creation." + }, + "diskControllerType": { + "$ref": "#/definitions/RestorePointSourceVMDiskControllerType", + "readOnly": true, + "description": "Gets the disk controller type of the VM captured at the time of the restore point creation." + } + }, + "description": "Describes the storage profile." + }, + "RestorePointSourceVMDiskControllerType": { + "type": "string", + "enum": [ + "SCSI", + "NVMe" + ], + "x-ms-enum": { + "name": "DiskControllerTypes", + "modelAsString": true + }, + "description": "Provides the disk controller type configured for the VM. 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). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes." + }, + "RestorePointSourceVMOSDisk": { + "properties": { + "osType": { + "type": "string", + "readOnly": true, + "description": "Gets the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemType", + "modelAsString": true + } + }, + "encryptionSettings": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSettings", + "description": "Gets the disk encryption settings." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the disk name." + }, + "caching": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/Caching", + "description": "Gets the caching type." + }, + "diskSizeGB": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "Gets the disk size in GB." + }, + "managedDisk": { + "$ref": "./computeRPCommon.json#/definitions/ManagedDiskParameters", + "description": "Gets the managed disk details" + }, + "diskRestorePoint": { + "$ref": "#/definitions/DiskRestorePointAttributes", + "description": "Contains Disk Restore Point properties." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "readOnly": true, + "description": "Shows true if the disk is write-accelerator enabled." + } + }, + "description": "Describes an Operating System disk." + }, + "RestorePointSourceVMDataDisk": { + "properties": { + "lun": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "Gets the logical unit number." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the disk name." + }, + "caching": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/Caching", + "description": "Gets the caching type." + }, + "diskSizeGB": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks." + }, + "managedDisk": { + "$ref": "./computeRPCommon.json#/definitions/ManagedDiskParameters", + "description": "Contains the managed disk details." + }, + "diskRestorePoint": { + "$ref": "#/definitions/DiskRestorePointAttributes", + "description": "Contains Disk Restore Point properties." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "readOnly": true, + "description": "Shows true if the disk is write-accelerator enabled." + } + }, + "description": "Describes a data disk." + }, + "DiskRestorePointAttributes": { + "type": "object", + "properties": { + "encryption": { + "$ref": "#/definitions/RestorePointEncryption" + }, + "sourceDiskRestorePoint": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "Resource Id of the source disk restore point." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + } + ], + "description": "Disk Restore Point details." + }, + "RestorePointEncryption": { + "type": "object", + "properties": { + "diskEncryptionSet": { + "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSetParameters" + }, + "type": { + "$ref": "#/definitions/RestorePointEncryptionType" + } + }, + "description": "Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point." + }, + "RestorePointEncryptionType": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk restore point.", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys" + ], + "x-ms-enum": { + "name": "RestorePointEncryptionType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithPlatformKey", + "description": "Disk Restore Point is encrypted at rest with Platform managed key. " + }, + { + "value": "EncryptionAtRestWithCustomerKey", + "description": "Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer." + }, + { + "value": "EncryptionAtRestWithPlatformAndCustomerKeys", + "description": "Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed." + } + ] + } + }, + "RestorePoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestorePointProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/ProxyResource" + } + ], + "description": "Restore Point details." + }, + "RestorePointInstanceView": { + "type": "object", + "properties": { + "diskRestorePoints": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskRestorePointInstanceView" + }, + "description": "The disk restore points information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of a restore point." + }, + "DiskRestorePointInstanceView": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Disk restore point Id." + }, + "replicationStatus": { + "$ref": "#/definitions/DiskRestorePointReplicationStatus", + "description": "The disk restore point replication status information." + } + }, + "description": "The instance view of a disk restore point." + }, + "DiskRestorePointReplicationStatus": { + "type": "object", + "properties": { + "status": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus", + "description": "The resource status information." + }, + "completionPercent": { + "type": "integer", + "format": "int32", + "description": "Replication completion percentage." + } + }, + "description": "The instance view of a disk restore point." + }, + "RestorePointProperties": { + "type": "object", + "properties": { + "excludeDisks": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference" + }, + "description": "List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included." + }, + "sourceMetadata": { + "$ref": "#/definitions/RestorePointSourceMetadata", + "description": "Gets the details of the VM captured at the time of the restore point creation." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Gets the provisioning state of the restore point." + }, + "consistencyMode": { + "type": "string", + "enum": [ + "CrashConsistent", + "FileSystemConsistent", + "ApplicationConsistent" + ], + "x-ms-enum": { + "name": "ConsistencyModeTypes", + "modelAsString": true + }, + "description": "ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details." + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Gets the creation time of the restore point." + }, + "sourceRestorePoint": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "Resource Id of the source restore point from which a copy needs to be created." + }, + "instanceView": { + "$ref": "#/definitions/RestorePointInstanceView", + "readOnly": true, + "description": "The restore point instance view." + } + }, + "description": "The restore point properties." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/runCommand.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/runCommand.json new file mode 100644 index 000000000000..679c0a9242f3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/runCommand.json @@ -0,0 +1,1332 @@ +{ + "swagger": "2.0", + "info": { + "title": "RunCommandsClient", + "description": "The Run Commands Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_List", + "x-ms-examples": { + "VirtualMachineRunCommandList": { + "$ref": "./examples/runCommandExamples/RunCommand_List.json" + } + }, + "description": "Lists all available run commands for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_Get", + "x-ms-examples": { + "VirtualMachineRunCommandGet": { + "$ref": "./examples/runCommandExamples/RunCommand_Get.json" + } + }, + "description": "Gets specific run command for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "The command id." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandDocument" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_RunCommand", + "x-ms-examples": { + "VirtualMachineRunCommand": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand.json" + } + }, + "description": "Run command on the VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_RunCommand", + "x-ms-examples": { + "VirtualMachineScaleSetVMs_RunCommand": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand.json" + } + }, + "description": "Run command on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands/{runCommandName}": { + "put": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_CreateOrUpdate", + "description": "The operation to create or update the run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the run command should be created or updated." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "runCommand", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + }, + "description": "Parameters supplied to the Create Virtual Machine RunCommand operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_Update", + "description": "The operation to update the run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the run command should be updated." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "runCommand", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommandUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine RunCommand operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_Update.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_Delete", + "description": "The operation to delete the run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the run command should be deleted." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_Delete.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_GetByVirtualMachine", + "description": "The operation to get the run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the run command." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommands": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_ListByVirtualMachine", + "description": "The operation to get all run commands of a Virtual Machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the run command." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommandsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List run commands in a Virtual Machine.": { + "$ref": "./examples/runCommandExamples/VirtualMachineRunCommand_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands/{runCommandName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMRunCommands" + ], + "operationId": "VirtualMachineScaleSetVMRunCommands_CreateOrUpdate", + "description": "The operation to create or update the VMSS VM run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "runCommand", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + }, + "description": "Parameters supplied to the Create Virtual Machine RunCommand operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create VirtualMachineScaleSet VM run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSetVMRunCommands" + ], + "operationId": "VirtualMachineScaleSetVMRunCommands_Update", + "description": "The operation to update the VMSS VM run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "runCommand", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommandUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine RunCommand operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update VirtualMachineScaleSet VM run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Update.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMRunCommands" + ], + "operationId": "VirtualMachineScaleSetVMRunCommands_Delete", + "description": "The operation to delete the VMSS VM run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete VirtualMachineScaleSet VM run command.": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Delete.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMRunCommands" + ], + "operationId": "VirtualMachineScaleSetVMRunCommands_Get", + "description": "The operation to get the VMSS VM run command.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "runCommandName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine run command." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommand" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get VirtualMachineScaleSet VM run commands.": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/runCommands": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMRunCommands" + ], + "operationId": "VirtualMachineScaleSetVMRunCommands_List", + "description": "The operation to get all run commands of an instance in Virtual Machine Scaleset.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineRunCommandsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List run commands in Vmss instance.": { + "$ref": "./examples/runCommandExamples/VirtualMachineScaleSetVMRunCommand_List.json" + } + } + } + } + }, + "definitions": { + "RunCommandInputParameter": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "value": { + "type": "string", + "description": "The run command parameter value." + } + }, + "required": [ + "name", + "value" + ], + "type": "object", + "description": "Describes the properties of a run command parameter." + }, + "RunCommandInput": { + "properties": { + "commandId": { + "type": "string", + "description": "The run command id." + }, + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. The script to be executed. When this value is given, the given script will override the default script of the command." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The run command parameters." + } + }, + "required": [ + "commandId" + ], + "type": "object", + "description": "Capture Virtual Machine parameters." + }, + "RunCommandParameterDefinition": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "type": { + "type": "string", + "description": "The run command parameter type." + }, + "defaultValue": { + "type": "string", + "description": "The run command parameter default value." + }, + "required": { + "type": "boolean", + "description": "The run command parameter required.", + "default": false + } + }, + "required": [ + "name", + "type" + ], + "type": "object", + "description": "Describes the properties of a run command parameter." + }, + "RunCommandDocumentBase": { + "properties": { + "$schema": { + "type": "string", + "description": "The VM run command schema." + }, + "id": { + "type": "string", + "description": "The VM run command id." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "label": { + "type": "string", + "description": "The VM run command label." + }, + "description": { + "type": "string", + "description": "The VM run command description." + } + }, + "required": [ + "$schema", + "id", + "osType", + "label", + "description" + ], + "type": "object", + "description": "Describes the properties of a Run Command metadata." + }, + "RunCommandDocument": { + "allOf": [ + { + "$ref": "#/definitions/RunCommandDocumentBase" + } + ], + "properties": { + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The script to be executed." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandParameterDefinition" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "The parameters used by the script." + } + }, + "required": [ + "script" + ], + "type": "object", + "description": "Describes the properties of a Run Command." + }, + "RunCommandListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandDocumentBase" + }, + "description": "The list of virtual machine run commands." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands." + } + }, + "required": [ + "value" + ], + "type": "object", + "description": "The List Virtual Machine operation response." + }, + "RunCommandManagedIdentity": { + "properties": { + "clientId": { + "type": "string", + "description": "Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided." + }, + "objectId": { + "type": "string", + "description": "Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided." + } + }, + "type": "object", + "description": " Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged." + }, + "RunCommandResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "Run command operation response." + } + }, + "type": "object" + }, + "VirtualMachineRunCommandInstanceView": { + "properties": { + "executionState": { + "type": "string", + "description": "Script execution status.", + "enum": [ + "Unknown", + "Pending", + "Running", + "Failed", + "Succeeded", + "TimedOut", + "Canceled" + ], + "x-ms-enum": { + "name": "ExecutionState", + "modelAsString": true + } + }, + "executionMessage": { + "type": "string", + "description": "Communicate script configuration errors or execution messages." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "description": "Exit code returned from script execution." + }, + "output": { + "type": "string", + "description": "Script output stream." + }, + "error": { + "type": "string", + "description": "Script error stream." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Script start time." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Script end time." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "type": "object", + "description": "The instance view of a virtual machine run command." + }, + "VirtualMachineRunCommandScriptSource": { + "properties": { + "script": { + "type": "string", + "description": "Specifies the script content to be executed on the VM." + }, + "scriptUri": { + "type": "string", + "description": "Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI." + }, + "commandId": { + "type": "string", + "description": "Specifies a commandId of predefined built-in script." + }, + "scriptUriManagedIdentity": { + "$ref": "#/definitions/RunCommandManagedIdentity", + "description": "User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged." + } + }, + "type": "object", + "description": "Describes the script sources for run command. Use only one of script, scriptUri, commandId." + }, + "VirtualMachineRunCommandProperties": { + "properties": { + "source": { + "$ref": "#/definitions/VirtualMachineRunCommandScriptSource", + "description": "The source of the run command script." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The parameters used by the script." + }, + "protectedParameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The parameters used by the script." + }, + "asyncExecution": { + "type": "boolean", + "description": "Optional. If set to true, provisioning will complete as soon as the script starts and will not wait for script to complete.", + "default": false + }, + "runAsUser": { + "type": "string", + "description": "Specifies the user account on the VM when executing the run command." + }, + "runAsPassword": { + "type": "string", + "description": "Specifies the user account password on the VM when executing the run command." + }, + "timeoutInSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout in seconds to execute the run command." + }, + "outputBlobUri": { + "type": "string", + "description": "Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter. " + }, + "errorBlobUri": { + "type": "string", + "description": "Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter." + }, + "outputBlobManagedIdentity": { + "$ref": "#/definitions/RunCommandManagedIdentity", + "description": "User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged " + }, + "errorBlobManagedIdentity": { + "$ref": "#/definitions/RunCommandManagedIdentity", + "description": "User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged " + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response. If treatFailureAsDeploymentFailure set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If treatFailureAsDeploymentFailure set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results " + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineRunCommandInstanceView", + "description": "The virtual machine run command instance view." + }, + "treatFailureAsDeploymentFailure": { + "type": "boolean", + "description": "Optional. If set to true, any failure in the script will fail the deployment and ProvisioningState will be marked as Failed. If set to false, ProvisioningState would only reflect whether the run command was run or not by the extensions platform, it would not indicate whether script failed in case of script failures. See instance view of run command in case of script failures to see executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results ", + "default": false + } + }, + "type": "object", + "description": "Describes the properties of a Virtual Machine run command." + }, + "VirtualMachineRunCommand": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineRunCommandProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "type": "object", + "description": "Describes a Virtual Machine run command." + }, + "VirtualMachineRunCommandUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineRunCommandProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "type": "object", + "description": "Describes a Virtual Machine run command." + }, + "VirtualMachineRunCommandsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineRunCommand" + }, + "description": "The list of run commands" + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of run commands." + } + }, + "required": [ + "value" + ], + "type": "object", + "description": "The List run command operation response" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/sshPublicKey.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/sshPublicKey.json new file mode 100644 index 000000000000..84d228e0d8d2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/sshPublicKey.json @@ -0,0 +1,518 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/sshPublicKeys": { + "get": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_ListBySubscription", + "description": "Lists all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeysGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SshPublicKey_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_ListBySubscription_MaximumSet_Gen.json" + }, + "SshPublicKey_ListBySubscription_MinimumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_ListBySubscription_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys": { + "get": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_ListByResourceGroup", + "description": "Lists all of the SSH public keys in the specified resource group. Use the nextLink property in the response to get the next page of SSH public keys.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeysGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SshPublicKey_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_ListByResourceGroup_MaximumSet_Gen.json" + }, + "SshPublicKey_ListByResourceGroup_MinimumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_ListByResourceGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}": { + "put": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Create", + "description": "Creates a new SSH public key resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + }, + "description": "Parameters supplied to create the SSH public key." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a new SSH public key resource.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Create.json" + } + } + }, + "patch": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Update", + "description": "Updates a new SSH public key resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SshPublicKeyUpdateResource" + }, + "description": "Parameters supplied to update the SSH public key." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SshPublicKey_Update_MaximumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Update_MaximumSet_Gen.json" + }, + "SshPublicKey_Update_MinimumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Delete", + "description": "Delete an SSH public key.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SshPublicKey_Delete_MaximumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Delete_MaximumSet_Gen.json" + }, + "SshPublicKey_Delete_MinimumSet_Gen": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Get", + "description": "Retrieves information about an SSH public key.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get an ssh public key.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}/generateKeyPair": { + "post": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_GenerateKeyPair", + "description": "Generates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This operation can only be performed once per SSH public key resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SshGenerateKeyPairInputParameters" + }, + "description": "Parameters supplied to generate the SSH public key." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyGenerateKeyPairResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Generate an SSH key pair.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair.json" + }, + "Generate an SSH key pair with RSA encryption.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithRSA.json" + }, + "Generate an SSH key pair with Ed25519 encryption.": { + "$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithEd25519.json" + } + } + } + } + }, + "definitions": { + "SshPublicKeyGenerateKeyPairResult": { + "properties": { + "privateKey": { + "type": "string", + "description": "Private key portion of the key pair used to authenticate to a virtual machine through ssh. The private key is returned in RFC3447 format and should be treated as a secret." + }, + "publicKey": { + "type": "string", + "description": "Public key portion of the key pair used to authenticate to a virtual machine through ssh. The public key is in ssh-rsa format." + }, + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{SshPublicKeyName}" + } + }, + "required": [ + "privateKey", + "publicKey", + "id" + ], + "description": "Response from generation of an SSH key pair." + }, + "SshPublicKeyResourceProperties": { + "properties": { + "publicKey": { + "type": "string", + "description": "SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format." + } + }, + "description": "Properties of the SSH public key." + }, + "SshPublicKeyResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SshPublicKeyResourceProperties", + "description": "Properties of the SSH public key." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the SSH public key." + }, + "SshPublicKeyUpdateResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SshPublicKeyResourceProperties", + "description": "Properties of the SSH public key." + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the SSH public key." + }, + "SshPublicKeysGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKeyResource" + }, + "description": "The list of SSH public keys" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of SSH public keys. Call ListNext() with this URI to fetch the next page of SSH public keys." + } + }, + "required": [ + "value" + ], + "description": "The list SSH public keys operation response." + }, + "SshGenerateKeyPairInputParameters": { + "type": "object", + "properties": { + "encryptionType": { + "type": "string", + "description": "The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA", + "enum": [ + "RSA", + "Ed25519" + ], + "x-ms-enum": { + "name": "SshEncryptionTypes", + "modelAsString": true + } + } + }, + "description": "Parameters for GenerateSshKeyPair." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachine.json new file mode 100644 index 000000000000..dff9d26cf5f0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachine.json @@ -0,0 +1,3581 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be created or updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Update", + "description": "The operation to update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update VM extension.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_Update.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be deleted." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineExtension_Delete_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_Delete_MaximumSet_Gen.json" + }, + "VirtualMachineExtension_Delete_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineExtension_Get_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_Get_MaximumSet_Gen.json" + }, + "VirtualMachineExtension_Get_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions": { + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_List", + "description": "The operation to get all extensions of a Virtual Machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineExtension_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_List_MaximumSet_Gen.json" + }, + "VirtualMachineExtension_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachineExtension_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListByLocation", + "description": "Gets all the virtual machines under the specified subscription for the specified location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which virtual machines under the subscription are queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists all the virtual machines under the specified subscription for the specified location.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ListBySubscription_ByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Capture", + "description": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureParameters" + }, + "description": "Parameters supplied to the Capture Virtual Machine operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureResult" + } + }, + "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": { + "VirtualMachine_Capture_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Capture_MaximumSet_Gen.json" + }, + "VirtualMachine_Capture_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Capture_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { + "put": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_CreateOrUpdate", + "description": "The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "Parameters supplied to the Create Virtual Machine operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting 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 result in error from server as they are not supported." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a vm with password authentication.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithPasswordAuthentication.json" + }, + "Create a vm with ssh authentication.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSshAuthentication.json" + }, + "Create a vm with premium storage.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithPremiumStorage.json" + }, + "Create a vm in a Virtual Machine Scale Set with customer assigned platformFaultDomain.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_InAVmssWithCustomerAssignedPlatformFaultDomain.json" + }, + "Create a vm in an availability set.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_InAnAvailabilitySet.json" + }, + "Create a vm with Scheduled Events Profile": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithScheduledEventsProfile.json" + }, + "Create a vm with boot diagnostics.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithBootDiagnostics.json" + }, + "Create a vm with managed boot diagnostics.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithManagedBootDiagnostics.json" + }, + "Create a vm with empty data disks.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithEmptyDataDisks.json" + }, + "Create a vm with a marketplace image plan.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithAMarketplaceImagePlan.json" + }, + "Create a vm from a custom image.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromACustomImage.json" + }, + "Create a platform-image vm with unmanaged os and data disks.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_PlatformImageVmWithUnmanagedOsAndDataDisks.json" + }, + "Create a custom-image vm from an unmanaged generalized os image.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_CustomImageVmFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a vm with ephemeral os disk.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDisk.json" + }, + "Create a vm with DiskEncryptionSet resource id in the os disk and data disk.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithDiskEncryptionSetResource.json" + }, + "Create a vm with ephemeral os disk provisioning in Resource disk using placement property.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json" + }, + "Create a vm with ephemeral os disk provisioning in Cache disk using placement property.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json" + }, + "Create a vm with Host Encryption using encryptionAtHost property.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionAtHost.json" + }, + "Create a Windows vm with a patch setting patchMode of AutomaticByOS.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByOS.json" + }, + "Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and AutomaticByPlatformSettings.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithAutomaticByPlatformSettings.json" + }, + "Create a Windows vm with patch settings patchMode and assessmentMode set to AutomaticByPlatform.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModesOfAutomaticByPlatform.json" + }, + "Create a Windows vm with a patch setting patchMode of Manual.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfManual.json" + }, + "Create a Windows vm with a patch setting assessmentMode of ImageDefault.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingAssessmentModeOfImageDefault.json" + }, + "Create a Windows vm with a patch setting patchMode of AutomaticByPlatform and enableHotpatching set to true.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WindowsVmWithPatchSettingModeOfAutomaticByPlatformAndEnableHotPatchingTrue.json" + }, + "Create a Linux vm with a patch settings patchMode and assessmentMode set to AutomaticByPlatform.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModesOfAutomaticByPlatform.json" + }, + "Create a Linux vm with a patch setting patchMode of ImageDefault.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingModeOfImageDefault.json" + }, + "Create a Linux vm with a patch setting patchMode of AutomaticByPlatform and AutomaticByPlatformSettings.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithAutomaticByPlatformSettings.json" + }, + "Create a Linux vm with a patch setting assessmentMode of ImageDefault.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_LinuxVmWithPatchSettingAssessmentModeOfImageDefault.json" + }, + "Create a vm with an extensions time budget.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithExtensionsTimeBudget.json" + }, + "Create a VM with Uefi Settings of secureBoot and vTPM.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithUefiSettings.json" + }, + "Create a VM with ProxyAgent Settings of enabled and mode.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithProxyAgentSettings.json" + }, + "Create a vm from a generalized shared image.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromAGeneralizedSharedImage.json" + }, + "Create a vm from a specialized shared image.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromASpecializedSharedImage.json" + }, + "Create a VM with network interface configuration": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfiguration.json" + }, + "Create a VM with network interface configuration with public ip address dns settings": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithNetworkInterfaceConfigurationDnsSettings.json" + }, + "Create a VM with UserData": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithUserData.json" + }, + "Create a vm with Application Profile.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithApplicationProfile.json" + }, + "Create a VM with HibernationEnabled": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithHibernationEnabled.json" + }, + "Create a VM with VM Size Properties": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithVMSizeProperties.json" + }, + "Create or update a VM with capacity reservation": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithCapacityReservation.json" + }, + "Create a VM from a shared gallery image": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromASharedGalleryImage.json" + }, + "Create a VM from a community gallery image": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_FromACommunityGalleryImage.json" + }, + "Create a VM with securityType ConfidentialVM with Platform Managed Keys": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVM.json" + }, + "Create a VM with securityType ConfidentialVM with Customer Managed Keys": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithCustomerManagedKeys.json" + }, + "Create a VM with securityType ConfidentialVM with NonPersistedTPM securityEncryptionType": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json" + }, + "Create a VM with Disk Controller Type": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithDiskControllerType.json" + }, + "Create a VM with encryption identity": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Create_WithEncryptionIdentity.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Update", + "description": "The operation to update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting 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 result in error from server as they are not supported." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a VM by detaching data disk": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Update_DetachDataDiskUsingToBeDetachedProperty.json" + }, + "Update a VM by force-detaching data disk": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Update_ForceDetachDataDisk.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Delete", + "description": "The operation to delete a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "forceDeletion", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to force delete virtual machines." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Force delete a VM": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Delete_Force.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Get", + "description": "Retrieves information about the model view or the instance view of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation.", + "enum": [ + "instanceView", + "userData" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a Virtual Machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get.json" + }, + "Get a virtual machine placed on a dedicated host group through automatic placement": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_AutoPlacedOnDedicatedHostGroup.json" + }, + "Get a virtual machine with VM Size Properties": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_WithVMSizeProperties.json" + }, + "Get a virtual machine with Disk Controller Type Properties": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_WithDiskControllerType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_InstanceView", + "description": "Retrieves information about the run-time state of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceView" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Virtual Machine Instance View.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_InstanceView.json" + }, + "Get instance view of a virtual machine placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ConvertToManagedDisks", + "description": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachine_ConvertToManagedDisks_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ConvertToManagedDisks_MaximumSet_Gen.json" + }, + "VirtualMachine_ConvertToManagedDisks_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ConvertToManagedDisks_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Deallocate", + "description": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "hibernate", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to hibernate a virtual machine. (Feature in Preview)" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachine_Deallocate_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Deallocate_MaximumSet_Gen.json" + }, + "VirtualMachine_Deallocate_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Deallocate_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Generalize", + "description": "Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation. For Windows, please refer to [Create a managed image of a generalized VM in Azure](https://docs.microsoft.com/azure/virtual-machines/windows/capture-image-resource). For Linux, please refer to [How to create an image of a virtual machine or VHD](https://docs.microsoft.com/azure/virtual-machines/linux/capture-image).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Generalize a Virtual Machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Generalize.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_List", + "description": "Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}'" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "ExpandTypeForListVMs", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachine_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_List_MaximumSet_Gen.json" + }, + "VirtualMachine_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAll", + "description": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "statusOnly", + "in": "query", + "required": false, + "type": "string", + "description": "statusOnly=true enables fetching run time status of all Virtual Machines in the subscription." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}'" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "ExpandTypesForListVMs", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachine_ListAll_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ListAll_MaximumSet_Gen.json" + }, + "VirtualMachine_ListAll_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ListAll_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAvailableSizes", + "description": "Lists all available virtual machine sizes to which the specified virtual machine can be resized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./computeRPCommon.json#/definitions/VirtualMachineSizeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Lists all available virtual machine sizes to which the specified virtual machine can be resized": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_ListAvailableVmSizes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PowerOff", + "description": "The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachine_PowerOff_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_PowerOff_MaximumSet_Gen.json" + }, + "VirtualMachine_PowerOff_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_PowerOff_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reapply": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reapply", + "description": "The operation to reapply a virtual machine's state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "Reapply the state of a virtual machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Reapply.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Restart", + "description": "The operation to restart a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachine_Restart_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Restart_MaximumSet_Gen.json" + }, + "VirtualMachine_Restart_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Restart_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Start", + "description": "The operation to start a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachine_Start_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Start_MaximumSet_Gen.json" + }, + "VirtualMachine_Start_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Start_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Redeploy", + "description": "Shuts down the virtual machine, moves it to a new node, and powers it back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachine_Redeploy_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Redeploy_MaximumSet_Gen.json" + }, + "VirtualMachine_Redeploy_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Redeploy_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reimage", + "description": "Reimages (upgrade the operating system) a virtual machine which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state. NOTE: The retaining of old OS disk depends on the value of deleteOption of OS disk. If deleteOption is detach, the old OS disk will be preserved after reimage. If deleteOption is delete, the old OS disk will be deleted after reimage. The deleteOption of the OS disk should be updated accordingly before performing the reimage.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineReimageParameters" + }, + "description": "Parameters supplied to the Reimage Virtual Machine operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "Reimage a Virtual Machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Reimage.json" + }, + "Reimage a Non-Ephemeral Virtual Machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_Reimage_NonEphemeralVMs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_RetrieveBootDiagnosticsData", + "description": "The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "sasUriExpirationTimeInMinutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. **Note:** If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RetrieveBootDiagnosticsDataResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "RetrieveBootDiagnosticsData of a virtual machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_RetrieveBootDiagnosticsData.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PerformMaintenance", + "description": "The operation to perform maintenance on a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachine_PerformMaintenance_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_PerformMaintenance_MaximumSet_Gen.json" + }, + "VirtualMachine_PerformMaintenance_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_PerformMaintenance_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/simulateEviction": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_SimulateEviction", + "description": "The operation to simulate the eviction of spot virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Simulate Eviction a virtual machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_SimulateEviction.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/assessPatches": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_AssessPatches", + "x-ms-examples": { + "Assess patch state of a virtual machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_AssessPatches.json" + } + }, + "description": "Assess patches on the VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineAssessPatchesResult" + } + }, + "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" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/installPatches": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_InstallPatches", + "description": "Installs patches on the VM.", + "x-ms-examples": { + "Install patch state of a virtual machine.": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_InstallPatches.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "installPatchesInput", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstallPatchesParameters" + }, + "description": "Input for InstallPatches as directly received by the API" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstallPatchesResult" + } + }, + "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" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/attachDetachDataDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_AttachDetachDataDisks", + "description": "Attach and detach data disks to/from the virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./computeRPCommon.json#/definitions/AttachDetachDataDisksRequest" + }, + "description": "Parameters supplied to the attach and detach data disks operation on the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./computeRPCommon.json#/definitions/StorageProfile" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": { + "VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MaximumSet_Gen.json" + }, + "VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExamples/VirtualMachine_AttachDetachDataDisks_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "RetrieveBootDiagnosticsDataResult": { + "properties": { + "consoleScreenshotBlobUri": { + "type": "string", + "readOnly": true, + "description": "The console screenshot blob URI" + }, + "serialConsoleLogBlobUri": { + "type": "string", + "readOnly": true, + "description": "The serial console log blob URI." + } + }, + "description": "The SAS URIs of the console screenshot and serial log blobs." + }, + "VirtualMachineExtensionInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "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." + }, + "substatuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView", + "description": "The virtual machine extension instance view." + }, + "suppressFailures": { + "type": "boolean", + "description": "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." + }, + "protectedSettingsFromKeyVault": { + "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference", + "description": "The extensions protected settings that are passed by reference, and consumed from key vault" + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdateProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "suppressFailures": { + "type": "boolean", + "description": "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." + }, + "protectedSettingsFromKeyVault": { + "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference", + "description": "The extensions protected settings that are passed by reference, and consumed from key vault" + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtension": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/ResourceWithOptionalLocation" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The list of extensions" + } + }, + "description": "The List Extension operation response" + }, + "VirtualMachineSoftwarePatchProperties": { + "properties": { + "patchId": { + "type": "string", + "readOnly": true, + "description": "A unique identifier for the patch." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The friendly name of the patch." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "The version number of the patch. This property applies only to Linux patches." + }, + "kbId": { + "type": "string", + "readOnly": true, + "description": "The KBID of the patch. Only applies to Windows patches." + }, + "classifications": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The classification(s) of the patch as provided by the patch publisher." + }, + "rebootBehavior": { + "type": "string", + "readOnly": true, + "description": "Describes the reboot requirements of the patch.", + "enum": [ + "Unknown", + "NeverReboots", + "AlwaysRequiresReboot", + "CanRequestReboot" + ], + "x-ms-enum": { + "name": "VMGuestPatchRebootBehavior", + "modelAsString": true + } + }, + "activityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "publishedDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the repository published this patch." + }, + "lastModifiedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp of the last update to this patch record." + }, + "assessmentState": { + "type": "string", + "readOnly": true, + "description": "Describes the availability of a given patch.", + "enum": [ + "Unknown", + "Available" + ], + "x-ms-enum": { + "name": "PatchAssessmentState", + "modelAsString": true + } + } + }, + "description": "Describes the properties of a Virtual Machine software patch." + }, + "VirtualMachineAssessPatchesResult": { + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "assessmentActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "rebootPending": { + "type": "boolean", + "readOnly": true, + "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred." + }, + "criticalAndSecurityPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of critical or security patches that have been detected as available and not yet installed." + }, + "otherPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches excluding critical and security." + }, + "startDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "availablePatches": { + "type": "array", + "readOnly": true, + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineSoftwarePatchProperties" + }, + "x-ms-identifiers": [ + "patchId" + ], + "description": "The list of patches that have been detected as available for installation." + }, + "error": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "Describes the properties of an AssessPatches result." + }, + "VirtualMachineInstallPatchesParameters": { + "properties": { + "maximumDuration": { + "type": "string", + "description": "Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours)" + }, + "rebootSetting": { + "type": "string", + "description": "Defines when it is acceptable to reboot a VM during a software update operation.", + "enum": [ + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "VMGuestPatchRebootSetting", + "modelAsString": true + } + }, + "windowsParameters": { + "$ref": "#/definitions/WindowsParameters", + "description": "Input for InstallPatches on a Windows VM, as directly received by the API" + }, + "linuxParameters": { + "$ref": "#/definitions/LinuxParameters", + "description": "Input for InstallPatches on a Linux VM, as directly received by the API" + } + }, + "required": [ + "rebootSetting" + ], + "description": "Input for InstallPatches as directly received by the API" + }, + "WindowsParameters": { + "properties": { + "classificationsToInclude": { + "type": "array", + "description": "The update classifications to select when installing patches for Windows.", + "items": { + "type": "string", + "enum": [ + "Critical", + "Security", + "UpdateRollUp", + "FeaturePack", + "ServicePack", + "Definition", + "Tools", + "Updates" + ], + "x-ms-enum": { + "name": "VMGuestPatchClassification_Windows", + "modelAsString": true + } + } + }, + "kbNumbersToInclude": { + "type": "array", + "description": "Kbs to include in the patch operation", + "items": { + "type": "string" + } + }, + "kbNumbersToExclude": { + "type": "array", + "description": "Kbs to exclude in the patch operation", + "items": { + "type": "string" + } + }, + "excludeKbsRequiringReboot": { + "type": "boolean", + "description": "Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true." + }, + "maxPatchPublishDate": { + "type": "string", + "format": "date-time", + "description": "This is used to install patches that were published on or before this given max published date." + } + }, + "description": "Input for InstallPatches on a Windows VM, as directly received by the API" + }, + "LinuxParameters": { + "properties": { + "classificationsToInclude": { + "type": "array", + "description": "The update classifications to select when installing patches for Linux.", + "items": { + "type": "string", + "enum": [ + "Critical", + "Security", + "Other" + ], + "x-ms-enum": { + "name": "VMGuestPatchClassification_Linux", + "modelAsString": true + } + } + }, + "packageNameMasksToInclude": { + "type": "array", + "description": "packages to include in the patch operation. Format: packageName_packageVersion", + "items": { + "type": "string" + } + }, + "packageNameMasksToExclude": { + "type": "array", + "description": "packages to exclude in the patch operation. Format: packageName_packageVersion", + "items": { + "type": "string" + } + }, + "maintenanceRunId": { + "type": "string", + "description": "This is used as a maintenance run identifier for Auto VM Guest Patching in Linux." + } + }, + "description": "Input for InstallPatches on a Linux VM, as directly received by the API" + }, + "VirtualMachineInstallPatchesResult": { + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Failed\", \"Succeeded\", \"Unknown\" or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "installationActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "rebootStatus": { + "type": "string", + "readOnly": true, + "description": "The reboot state of the VM following completion of the operation.", + "enum": [ + "Unknown", + "NotNeeded", + "Required", + "Started", + "Failed", + "Completed" + ], + "x-ms-enum": { + "name": "VMGuestPatchRebootStatus", + "modelAsString": true + } + }, + "maintenanceWindowExceeded": { + "type": "boolean", + "readOnly": true, + "description": "Whether the operation ran out of time before it completed all its intended actions." + }, + "excludedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were not installed due to the user blocking their installation." + }, + "notSelectedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were detected as available for install, but did not meet the operation's criteria." + }, + "pendingPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true." + }, + "installedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches successfully installed." + }, + "failedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that could not be installed due to some issue. See errors for details." + }, + "patches": { + "type": "array", + "readOnly": true, + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PatchInstallationDetail" + }, + "x-ms-identifiers": [ + "patchId" + ], + "description": "The patches that were installed during the operation." + }, + "startDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "error": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "The result summary of an installation operation." + }, + "PatchInstallationDetail": { + "properties": { + "patchId": { + "type": "string", + "readOnly": true, + "description": "A unique identifier for the patch." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The friendly name of the patch." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "The version string of the package. It may conform to Semantic Versioning. Only applies to Linux." + }, + "kbId": { + "type": "string", + "readOnly": true, + "description": "The KBID of the patch. Only applies to Windows patches." + }, + "classifications": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The classification(s) of the patch as provided by the patch publisher." + }, + "installationState": { + "type": "string", + "readOnly": true, + "description": "The state of the patch after the installation operation completed.", + "enum": [ + "Unknown", + "Installed", + "Failed", + "Excluded", + "NotSelected", + "Pending" + ], + "x-ms-enum": { + "name": "PatchInstallationState", + "modelAsString": true + } + } + }, + "description": "Information about a specific patch that was encountered during an installation action." + }, + "VirtualMachineReimageParameters": { + "properties": { + "tempDisk": { + "type": "boolean", + "description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk." + }, + "exactVersion": { + "type": "string", + "description": "Specifies in decimal number, the version the OS disk should be reimaged to. If exact version is not provided, the OS disk is reimaged to the existing version of OS Disk." + }, + "osProfile": { + "$ref": "#/definitions/OSProfileProvisioningData", + "description": "Specifies information required for reimaging the non-ephemeral OS disk." + } + }, + "description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged" + }, + "OSProfileProvisioningData": { + "type": "object", + "properties": { + "adminPassword": { + "type": "string", + "description": "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)", + "x-ms-secret": true + }, + "customData": { + "type": "string", + "description": "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. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). If using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)." + } + }, + "description": "Additional parameters for Reimaging Non-Ephemeral Virtual Machine." + }, + "VirtualMachineCaptureParameters": { + "properties": { + "vhdPrefix": { + "type": "string", + "description": "The captured virtual hard disk's name prefix." + }, + "destinationContainerName": { + "type": "string", + "description": "The destination container name." + }, + "overwriteVhds": { + "type": "boolean", + "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict." + } + }, + "required": [ + "vhdPrefix", + "destinationContainerName", + "overwriteVhds" + ], + "description": "Capture Virtual Machine parameters." + }, + "VirtualMachineCaptureResult": { + "properties": { + "$schema": { + "readOnly": true, + "type": "string", + "description": "the schema of the captured virtual machine" + }, + "contentVersion": { + "readOnly": true, + "type": "string", + "description": "the version of the content" + }, + "parameters": { + "readOnly": true, + "type": "object", + "description": "parameters of the captured virtual machine" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "description": "resource item" + }, + "x-ms-identifiers": [], + "description": "a list of resource items of the captured virtual machine" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "Output of virtual machine capture operation.", + "x-ms-azure-resource": true + }, + "VirtualMachineIpTag": { + "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." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachinePublicIPAddressDnsSettingsConfiguration": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID." + }, + "domainNameLabelScope": { + "type": "string", + "description": "The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID.", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "DomainNameLabelScopeTypes", + "modelAsString": true + } + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines network configuration's DNS settings." + }, + "VirtualMachinePublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the public IP address when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachinePublicIPAddressDnsSettingsConfiguration", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineIpTag" + }, + "x-ms-identifiers": [], + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPPrefix": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "publicIPAddressVersion": { + "type": "string", + "description": "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'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersions", + "modelAsString": true + } + }, + "publicIPAllocationMethod": { + "type": "string", + "description": "Specify the public IP allocation type", + "enum": [ + "Dynamic", + "Static" + ], + "x-ms-enum": { + "name": "PublicIPAllocationMethod", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machines IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachinePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachinePublicIPAddressConfigurationProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/PublicIPAddressSku" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineNetworkInterfaceIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachinePublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "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'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersions", + "modelAsString": true + } + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]." + } + }, + "description": "Describes a virtual machine network interface IP configuration properties." + }, + "VirtualMachineNetworkInterfaceIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineNetworkInterfaceIPConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine network profile's IP configuration." + }, + "VirtualMachineNetworkInterfaceDnsSettingsConfiguration": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines network configuration's DNS settings." + }, + "VirtualMachineNetworkInterfaceConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "deleteOption": { + "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 + } + }, + "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." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + }, + "networkSecurityGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineNetworkInterfaceDnsSettingsConfiguration", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineNetworkInterfaceIPConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies the IP configurations of the network interface." + }, + "dscpConfiguration": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "auxiliaryMode": { + "type": "string", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface resource.", + "enum": [ + "None", + "AcceleratedConnections", + "Floating" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true + } + }, + "auxiliarySku": { + "type": "string", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface resource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true + } + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine network profile's IP configuration." + }, + "VirtualMachineNetworkInterfaceConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network interface configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineNetworkInterfaceConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine network interface configurations." + }, + "VirtualMachineExtensionHandlerInstanceView": { + "properties": { + "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." + }, + "status": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus", + "description": "The extension handler status." + } + }, + "description": "The instance view of a virtual machine extension handler." + }, + "VirtualMachineAgentInstanceView": { + "properties": { + "vmAgentVersion": { + "type": "string", + "description": "The VM Agent full version." + }, + "extensionHandlers": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView" + }, + "x-ms-identifiers": [], + "description": "The virtual machine extension handler instance view." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + } + }, + "description": "The instance view of the VM Agent running on the virtual machine." + }, + "VirtualMachineIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "$ref": "../../../common-types/v1/common.json#/definitions/UserAssignedIdentities", + "description": "The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine." + }, + "VirtualMachineInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the update domain of the virtual machine." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the fault domain of the virtual machine." + }, + "computerName": { + "type": "string", + "description": "The computer name assigned to the virtual machine." + }, + "osName": { + "type": "string", + "description": "The Operating System running on the virtual machine." + }, + "osVersion": { + "type": "string", + "description": "The version of Operating System running on the virtual machine." + }, + "hyperVGeneration": { + "type": "string", + "description": "Specifies the HyperVGeneration Type associated with a resource", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationType", + "modelAsString": true + } + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "./computeRPCommon.json#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/DiskInstanceView" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The virtual machine disk information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "./computeRPCommon.json#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "assignedHost": { + "type": "string", + "readOnly": true, + "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + }, + "patchStatus": { + "$ref": "#/definitions/VirtualMachinePatchStatus", + "description": "[Preview Feature] The status of virtual machine patch operations." + }, + "isVMInStandbyPool": { + "type": "boolean", + "readOnly": true, + "description": "[Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool." + } + }, + "description": "The instance view of a virtual machine." + }, + "VirtualMachineProperties": { + "properties": { + "hardwareProfile": { + "$ref": "./computeRPCommon.json#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "./computeRPCommon.json#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine." + }, + "osProfile": { + "$ref": "./computeRPCommon.json#/definitions/OSProfile", + "description": "Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "networkProfile": { + "$ref": "./computeRPCommon.json#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "securityProfile": { + "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference." + }, + "virtualMachineScaleSet": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01." + }, + "proximityPlacementGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01." + }, + "priority": { + "$ref": "./computeRPCommon.json#/definitions/priority", + "description": "Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01" + }, + "evictionPolicy": { + "$ref": "./computeRPCommon.json#/definitions/evictionPolicy", + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "billingProfile": { + "$ref": "./computeRPCommon.json#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01." + }, + "host": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01." + }, + "hostGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the dedicated host group that the virtual machine resides in. **Note:** User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "licenseType": { + "type": "string", + "description": "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" + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands." + }, + "extensionsTimeBudget": { + "type": "string", + "description": "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." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01." + }, + "scheduledEventsProfile": { + "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + }, + "userData": { + "type": "string", + "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01." + }, + "capacityReservation": { + "$ref": "./computeRPCommon.json#/definitions/CapacityReservationProfile", + "description": "Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01." + }, + "applicationProfile": { + "$ref": "./computeRPCommon.json#/definitions/ApplicationProfile", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachine": { + "properties": { + "plan": { + "$ref": "./computeRPCommon.json#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "managedBy": { + "readOnly": true, + "type": "string", + "description": "ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "VirtualMachineUpdate": { + "properties": { + "plan": { + "$ref": "./computeRPCommon.json#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Update." + }, + "VirtualMachineListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "The list of virtual machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineHealthStatus": { + "properties": { + "status": { + "readOnly": true, + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus", + "description": "The health status information for the VM." + } + }, + "description": "The health status of the VM." + }, + "VirtualMachinePatchStatus": { + "properties": { + "availablePatchSummary": { + "$ref": "#/definitions/AvailablePatchSummary", + "description": "The available patch summary of the latest assessment operation for the virtual machine." + }, + "lastPatchInstallationSummary": { + "$ref": "#/definitions/LastPatchInstallationSummary", + "description": "The installation summary of the latest installation operation for the virtual machine." + }, + "configurationStatuses": { + "description": "The enablement status of the specified patchMode", + "readOnly": true, + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [] + } + }, + "description": "The status of virtual machine patch operations." + }, + "AvailablePatchSummary": { + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "assessmentActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "rebootPending": { + "type": "boolean", + "readOnly": true, + "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred." + }, + "criticalAndSecurityPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of critical or security patches that have been detected as available and not yet installed." + }, + "otherPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches excluding critical and security." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "lastModifiedTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "error": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "Describes the properties of an virtual machine instance view for available patch summary." + }, + "LastPatchInstallationSummary": { + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "installationActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "maintenanceWindowExceeded": { + "type": "boolean", + "readOnly": true, + "description": "Describes whether the operation ran out of time before it completed all its intended actions" + }, + "notSelectedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry." + }, + "excludedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches but excluded explicitly by a customer-specified exclusion list match." + }, + "pendingPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches expected to be installed over the course of the patch installation operation." + }, + "installedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The count of patches that successfully installed." + }, + "failedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The count of patches that failed installation." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "lastModifiedTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "error": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "Describes the properties of the last installed patch summary." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineExtensionImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineExtensionImage.json new file mode 100644 index 000000000000..7c100a32b48a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineExtensionImage.json @@ -0,0 +1,289 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_Get", + "description": "Gets a virtual machine extension image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineExtensionImage_Get_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_Get_MaximumSet_Gen.json" + }, + "VirtualMachineExtensionImage_Get_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListTypes", + "description": "Gets a list of virtual machine extension image types.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineExtensionImage_ListTypes_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListTypes_MaximumSet_Gen.json" + }, + "VirtualMachineExtensionImage_ListTypes_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListTypes_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListVersions", + "description": "Gets a list of virtual machine extension image versions.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineExtensionImage", + "x-ms-examples": { + "VirtualMachineExtensionImage_ListVersions_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListVersions_MaximumSet_Gen.json" + }, + "VirtualMachineExtensionImage_ListVersions_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineExtensionImageExamples/VirtualMachineExtensionImage_ListVersions_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "VirtualMachineExtensionImageProperties": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system this extension supports." + }, + "computeRole": { + "type": "string", + "description": "The type of role (IaaS or PaaS) this extension supports." + }, + "handlerSchema": { + "type": "string", + "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema." + }, + "vmScaleSetEnabled": { + "type": "boolean", + "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS." + }, + "supportsMultipleExtensions": { + "type": "boolean", + "description": "Whether the handler can support multiple extensions." + } + }, + "required": [ + "operatingSystem", + "computeRole", + "handlerSchema" + ], + "description": "Describes the properties of a Virtual Machine Extension Image." + }, + "VirtualMachineExtensionImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension Image." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineImage.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineImage.json new file mode 100644 index 000000000000..890608e85df8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineImage.json @@ -0,0 +1,1064 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_Get", + "description": "Gets a virtual machine image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU version." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImage_Get_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_Get_MaximumSet_Gen.json" + }, + "VirtualMachineImage_Get_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_List", + "description": "Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImage_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_List_MaximumSet_Gen.json" + }, + "VirtualMachineImage_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListOffers", + "description": "Gets a list of virtual machine image offers for the specified location and publisher.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImage_ListOffers_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListOffers_MaximumSet_Gen.json" + }, + "VirtualMachineImage_ListOffers_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListOffers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListPublishers", + "description": "Gets a list of virtual machine image publishers for the specified Azure location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImage_ListPublishers_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListPublishers_MaximumSet_Gen.json" + }, + "VirtualMachineImage_ListPublishers_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListPublishers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListSkus", + "description": "Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImage_ListSkus_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListSkus_MaximumSet_Gen.json" + }, + "VirtualMachineImage_ListSkus_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImage_ListSkus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImagesEdgeZone_Get", + "description": "Gets a virtual machine image in an edge zone.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU version." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImagesEdgeZone_List", + "description": "Gets a list of all virtual machine image versions for the specified location, edge zone, publisher, offer, and SKU.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "An integer value specifying the number of images to return that matches supplied values." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the order of the results returned. Formatted as an OData query." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImagesEdgeZone_ListOffers", + "description": "Gets a list of virtual machine image offers for the specified location, edge zone and publisher.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListOffers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImagesEdgeZone_ListPublishers", + "description": "Gets a list of virtual machine image publishers for the specified Azure location and edge zone.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListPublishers_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/vmimages": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListByEdgeZone", + "description": "Gets a list of all virtual machine image versions for the specified edge zone", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VmImagesInEdgeZoneListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListByEdgeZone_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImagesEdgeZone_ListSkus", + "description": "Gets a list of virtual machine image SKUs for the specified location, edge zone, publisher, and offer.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "edgeZone", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the edge zone." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MaximumSet_Gen.json" + }, + "VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineImageExamples/VirtualMachineImagesEdgeZone_ListSkus_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "DisallowedConfiguration": { + "properties": { + "vmDiskType": { + "type": "string", + "description": "VM disk types which are disallowed.", + "enum": [ + "None", + "Unmanaged" + ], + "x-ms-enum": { + "name": "VmDiskTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the disallowed configuration for a virtual machine image." + }, + "VirtualMachineImageResource": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "location": { + "type": "string", + "description": "The supported Azure location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md)." + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + } + ], + "description": "Virtual machine image resource information." + }, + "PurchasePlan": { + "properties": { + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + } + }, + "required": [ + "publisher", + "name", + "product" + ], + "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." + }, + "OSDiskImage": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system of the osDiskImage.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + } + }, + "required": [ + "operatingSystem" + ], + "description": "Contains the os disk image information." + }, + "DataDiskImage": { + "properties": { + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Contains the data disk images information." + }, + "AutomaticOSUpgradeProperties": { + "properties": { + "automaticOSUpgradeSupported": { + "type": "boolean", + "description": "Specifies whether automatic OS upgrade is supported on the image." + } + }, + "required": [ + "automaticOSUpgradeSupported" + ], + "description": "Describes automatic OS upgrade properties on the image." + }, + "ImageDeprecationStatus": { + "type": "object", + "properties": { + "imageState": { + "type": "string", + "description": "Describes the state of the image.", + "enum": [ + "Active", + "ScheduledForDeprecation", + "Deprecated" + ], + "x-ms-enum": { + "name": "ImageState", + "modelAsString": true + } + }, + "scheduledDeprecationTime": { + "type": "string", + "format": "date-time", + "description": "The time, in future, at which this image will be marked as deprecated. This scheduled time is chosen by the Publisher." + }, + "alternativeOption": { + "$ref": "#/definitions/AlternativeOption" + } + }, + "description": "Describes image deprecation status properties on the image." + }, + "AlternativeOption": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Describes the type of the alternative option.", + "enum": [ + "None", + "Offer", + "Plan" + ], + "x-ms-enum": { + "name": "AlternativeType", + "modelAsString": true + } + }, + "value": { + "type": "string", + "description": "Indicates the alternative option value specified by the Publisher. This is the Offer name when the type is Offer or the Plan name when the type is Plan." + } + }, + "description": "Describes the alternative option specified by the Publisher for this image when this image is deprecated." + }, + "VirtualMachineImageFeature": { + "properties": { + "name": { + "type": "string", + "description": "The name of the feature." + }, + "value": { + "type": "string", + "description": "The corresponding value for the feature." + } + }, + "description": "Specifies additional capabilities supported by the image" + }, + "VirtualMachineImageProperties": { + "properties": { + "plan": { + "$ref": "#/definitions/PurchasePlan" + }, + "osDiskImage": { + "$ref": "#/definitions/OSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImage" + }, + "x-ms-identifiers": [ + "lun" + ] + }, + "automaticOSUpgradeProperties": { + "$ref": "#/definitions/AutomaticOSUpgradeProperties" + }, + "hyperVGeneration": { + "$ref": "./computeRPCommon.json#/definitions/HyperVGenerationType" + }, + "disallowed": { + "$ref": "#/definitions/DisallowedConfiguration", + "description": "Specifies disallowed configuration for the VirtualMachine created from the image" + }, + "features": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageFeature" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "architecture": { + "$ref": "#/definitions/ArchitectureType" + }, + "imageDeprecationStatus": { + "$ref": "#/definitions/ImageDeprecationStatus" + } + }, + "description": "Describes the properties of a Virtual Machine Image." + }, + "VirtualMachineImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineImageResource" + } + ], + "description": "Describes a Virtual Machine Image." + }, + "VmImagesInEdgeZoneListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + }, + "description": "The list of VMImages in EdgeZone" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of VMImages in EdgeZone. Call ListNext() with this URI to fetch the next page of VmImages." + } + }, + "description": "The List VmImages in EdgeZone operation response." + }, + "ArchitectureType": { + "type": "string", + "description": "Specifies the Architecture Type", + "enum": [ + "x64", + "Arm64" + ], + "x-ms-enum": { + "name": "ArchitectureTypes", + "modelAsString": true + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json new file mode 100644 index 000000000000..0626c555a36b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json @@ -0,0 +1,6334 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2023-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListByLocation", + "description": "Gets all the VM scale sets under the specified subscription for the specified location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which VM scale sets under the subscription are queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Lists all the VM scale sets under the specified subscription for the specified location.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListBySubscription_ByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { + "put": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_CreateOrUpdate", + "description": "Create or update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The scale set object." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting 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 result in error from server as they are not supported." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a scale set with password authentication.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPasswordAuthentication.json" + }, + "Create a scale set with ssh authentication.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSshAuthentication.json" + }, + "Create a scale set with premium storage.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPremiumStorage.json" + }, + "Create a scale set with empty data disks on each vm.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEmptyDataDisksOnEachVm.json" + }, + "Create a scale set with an azure load balancer.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureLoadBalancer.json" + }, + "Create a scale set with an azure application gateway.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAzureApplicationGateway.json" + }, + "Create a scale set with boot diagnostics.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithBootDiagnostics.json" + }, + "Create a scale set with managed boot diagnostics.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithManagedBootDiagnostics.json" + }, + "Create a scale set with a marketplace image plan.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAMarketplaceImagePlan.json" + }, + "Create a scale set from a custom image.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromACustomImage.json" + }, + "Create a platform-image scale set with unmanaged os disks.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_PlatformImageWithUnmanagedOsDisks.json" + }, + "Create a custom-image scale set from an unmanaged generalized os image.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_CustomImageFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a scale set with virtual machines in different zones.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMsInDifferentZones.json" + }, + "Create a scale set with ephemeral os disks.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiffOsDisk.json" + }, + "Create a scale set with terminate scheduled events enabled.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithTerminateScheduledEventEnabled.json" + }, + "Create a scale set with OS image scheduled events enabled.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithOSImageScheduledEventEnabled.json" + }, + "Create a scale set with automatic repairs enabled": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithAutomaticRepairs.json" + }, + "Create a scale set with DiskEncryptionSet resource in os disk and data disk.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskEncryptionSetResource.json" + }, + "Create a scale set with ephemeral os disks using placement property.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_CreateA_WithDiffOsDiskUsingDiffDiskPlacement.json" + }, + "Create a scale set with extension time budget.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsTimeBudget.json" + }, + "Create a scale set with Host Encryption using encryptionAtHost property.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithEncryptionAtHost.json" + }, + "Create a scale set with Fpga Network Interfaces.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithFpgaNetworkInterface.json" + }, + "Create a scale set with Network Interfaces with public ip address dns settings.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithNetworkInterfaceWithDnsSettings.json" + }, + "Create a scale set with Uefi Settings of secureBoot and vTPM.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUefiSettings.json" + }, + "Create a scale set with ProxyAgent Settings of enabled and mode.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProxyAgentSettings.json" + }, + "Create a scale set from a generalized shared image.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromAGeneralizedSharedImage.json" + }, + "Create a scale set from a specialized shared image.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromASpecializedSharedImage.json" + }, + "Create a scale set with userData.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithUserData.json" + }, + "Create a scale set with Application Profile": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithApplicationProfile.json" + }, + "Create a scale set with scaleInPolicy.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithScaleInPolicy.json" + }, + "Create a VMSS with an extension that has suppressFailures enabled": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithExtensionsSuppressFailuresEnabled.json" + }, + "Create or update a scale set with capacity reservation.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithCapacityReservation.json" + }, + "Create a scale set with spot restore policy": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSpotRestorePolicy.json" + }, + "Create a scale set with priority mix policy": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithPriorityMixPolicy.json" + }, + "Create a VMSS with an extension with protectedSettingsFromKeyVault": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithProtectedSettingsFromKeyVault.json" + }, + "Create a scale set with vm size properties": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithVMSizeProperties.json" + }, + "Create a scale set with SecurityType as ConfidentialVM": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVM.json" + }, + "Create a scale set with Disk Controller Type": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithDiskControllerType.json" + }, + "Create a scale set where nic config has DisableTcpStateTracking property": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_FromWithDisableTcpStateTrackingNetworkInterface.json" + }, + "Create a scale set with Service Artifact Reference": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithServiceArtifactReference.json" + }, + "Create a scale set with Security Posture Reference": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityPostureReference.json" + }, + "Create a scale set with Resilient VM Creation enabled": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMCreationPolicy.json" + }, + "Create a scale set with Resilient VM Deletion enabled": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithResilientVMDeletionPolicy.json" + }, + "Create a scale set with SecurityType as ConfidentialVM and NonPersistedTPM securityEncryptionType": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Create_WithSecurityTypeConfidentialVMWithNonPersistedTPM.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Update", + "description": "Update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdate" + }, + "description": "The scale set object." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting 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 result in error from server as they are not supported." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_Update_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Update_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Delete", + "description": "Deletes a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "forceDeletion", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to force delete a VM scale set. (Feature in Preview)" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Force Delete a VM scale set.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Delete_Force.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Get", + "description": "Display information about a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'UserData' retrieves the UserData property of the VM scale set that was provided by the user during the VM scale set Create/Update operation", + "enum": [ + "userData" + ], + "x-ms-enum": { + "name": "ExpandTypesForGetVMScaleSets", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a virtual machine scale set placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_AutoPlacedOnDedicatedHostGroup.json" + }, + "Get a virtual machine scale set with UserData": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithUserData.json" + }, + "Get a virtual machine scale set": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get.json" + }, + "Get VM scale set VM with Disk Controller Type": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Get_WithDiskControllerType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Deallocate", + "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "name": "hibernate", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to hibernate a virtual machine from the VM scale set. (This feature is available for VMSS with Flexible OrchestrationMode only)" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_Deallocate_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Deallocate_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Deallocate_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_DeleteInstances", + "description": "Deletes virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "name": "forceDeletion", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to force delete virtual machines from the VM scale set. (Feature in Preview)" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_DeleteInstances_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_DeleteInstances_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_DeleteInstances_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetInstanceView", + "description": "Gets the status of a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetInstanceView_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_List", + "description": "Gets a list of all VM scale sets under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachineScaleSet_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate", + "description": "The operation to create or update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "Parameters supplied to the Create VM scale set Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetExtension_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_CreateOrUpdate_MinimumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Update", + "description": "The operation to update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionUpdate" + }, + "description": "Parameters supplied to the Update VM scale set Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetExtension_Update_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetExtension_Update_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be deleted." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetExtension_Delete_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetExtension_Delete_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Delete_MinimumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineScaleSetExtension_Get_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetExtension_Get_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_Get_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_List", + "description": "Gets a list of all extensions in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachineScaleSetExtension_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetExtension_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListAll", + "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachineScaleSet_ListAll_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_ListAll_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListAll_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListSkus", + "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachineScaleSet_ListSkus_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_ListSkus_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ListSkus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory", + "description": "Gets list of OS upgrades on a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PowerOff", + "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_PowerOff_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_PowerOff_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PowerOff_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Restart", + "description": "Restarts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_Restart_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Restart_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Restart_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Start", + "description": "Starts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_Start_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Start_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Start_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reapply": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Reapply", + "description": "Reapplies the Virtual Machine Scale Set Virtual Machine Profile to the Virtual Machine Instances", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": { + "VirtualMachineScaleSets_Reapply_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSets_Reapply_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reapply_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Redeploy", + "description": "Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_Redeploy_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Redeploy_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Redeploy_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PerformMaintenance", + "description": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_PerformMaintenance_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_PerformMaintenance_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_PerformMaintenance_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_UpdateInstances", + "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_UpdateInstances_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_UpdateInstances_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_UpdateInstances_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Reimage", + "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmScaleSetReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetReimageParameters" + }, + "description": "Parameters for Reimaging VM ScaleSet." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_Reimage_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_Reimage_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_Reimage_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ReimageAll", + "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_ReimageAll_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_ReimageAll_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ReimageAll_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/approveRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ApproveRollingUpgrade", + "description": "Approve upgrade on deferred rolling upgrades for OS disks in the virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSet_ApproveRollingUpgrade": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ApproveRollingUpgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel", + "description": "Cancels the current virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSetRollingUpgrade_Cancel_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetRollingUpgrade_Cancel_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_Cancel_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade", + "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_StartOSUpgrade_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade", + "description": "Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "Start an extension rolling upgrade.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetExtension_RollingUpgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { + "get": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest", + "description": "Gets the status of the latest virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RollingUpgradeStatusInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk", + "description": "Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "platformUpdateDomain", + "in": "query", + "required": true, + "type": "integer", + "description": "The platform update domain for which a manual recovery walk is requested" + }, + { + "name": "zone", + "in": "query", + "required": false, + "type": "string", + "description": "The zone in which the manual recovery walk is requested for cross zone virtual machine scale set" + }, + { + "name": "placementGroupId", + "in": "query", + "required": false, + "type": "string", + "description": "The placement group id for which the manual recovery walk is requested." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryWalkResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ForceRecoveryServiceFabricPlatformUpdateDomainWalk_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup", + "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VMScaleSetConvertToSinglePlacementGroupInput" + }, + "description": "The input object for ConvertToSinglePlacementGroup API." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_ConvertToSinglePlacementGroup_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/setOrchestrationServiceState": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_SetOrchestrationServiceState", + "description": "Changes ServiceState property for a given service", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OrchestrationServiceStateInput" + }, + "description": "The input object for SetOrchestrationServiceState API." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_CreateOrUpdate", + "description": "The operation to create or update the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Create.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Update", + "description": "The operation to update the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Update.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Delete", + "description": "The operation to delete the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Delete.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Get", + "description": "The operation to get the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_List", + "description": "The operation to get all extensions of an instance in Virtual Machine Scaleset.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List extensions in Vmss instance.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVMExtension_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Reimage", + "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmScaleSetVMReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + }, + "description": "Parameters for the Reimaging Virtual machine in ScaleSet." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSetVM_Reimage_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Reimage_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Reimage_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ReimageAll", + "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSetVM_ReimageAll_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_ReimageAll_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ReimageAll_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/approveRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ApproveRollingUpgrade", + "description": "Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_ApproveRollingUpgrade": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_ApproveRollingUpgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Deallocate", + "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSetVM_Deallocate_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Deallocate_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Deallocate_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Update", + "description": "Updates a virtual machine of a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "Parameters supplied to the Update Virtual Machine Scale Sets VM operation." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting 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 result in error from server as they are not supported." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VirtualMachineScaleSetVM_Update_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Update_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Update_MinimumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Delete", + "description": "Deletes a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "forceDeletion", + "in": "query", + "required": false, + "type": "boolean", + "description": "Optional parameter to force delete a virtual machine from a VM scale set. (Feature in Preview)" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Force Delete a virtual machine from a VM scale set.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Delete_Force.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Get", + "description": "Gets a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. 'InstanceView' will retrieve the instance view of the virtual machine. 'UserData' will retrieve the UserData of the virtual machine.", + "enum": [ + "instanceView", + "userData" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get VM scale set VM with UserData": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithUserData.json" + }, + "Get VM scale set VM with VMSizeProperties": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_WithVMSizeProperties.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_GetInstanceView", + "description": "Gets the status of a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Get_InstanceViewAutoPlacedOnDedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_List", + "description": "Gets a list of all virtual machines in a VM scale sets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM", + "x-ms-examples": { + "VirtualMachineScaleSetVM_List_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_List_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PowerOff", + "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSetVM_PowerOff_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_PowerOff_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PowerOff_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Restart", + "description": "Restarts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSetVM_Restart_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Restart_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Restart_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Start", + "description": "Starts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSetVM_Start_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Start_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Start_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Redeploy", + "description": "Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSetVM_Redeploy_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_Redeploy_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_Redeploy_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/retrieveBootDiagnosticsData": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData", + "description": "The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "sasUriExpirationTimeInMinutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes. **Note:** If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./virtualMachine.json#/definitions/RetrieveBootDiagnosticsDataResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "RetrieveBootDiagnosticsData of a virtual machine.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_RetrieveBootDiagnosticsData.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PerformMaintenance", + "description": "Performs maintenance on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "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-examples": { + "VirtualMachineScaleSetVM_PerformMaintenance_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_PerformMaintenance_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_PerformMaintenance_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/simulateEviction": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_SimulateEviction", + "description": "The operation to simulate the eviction of spot virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Simulate Eviction a virtual machine.": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_SimulateEviction.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/attachDetachDataDisks": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_AttachDetachDataDisks", + "description": "Attach and detach data disks to/from a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./computeRPCommon.json#/definitions/AttachDetachDataDisksRequest" + }, + "description": "Parameters supplied to the attach and detach data disks operation on a Virtual Machine Scale Sets VM." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./computeRPCommon.json#/definitions/StorageProfile" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "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": { + "VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MaximumSet_Gen.json" + }, + "VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen": { + "$ref": "./examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetVM_AttachDetachDataDisks_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "VirtualMachineScaleSetVMExtension": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "The location of the extension.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a VMSS VM Extension.", + "x-ms-azure-resource": true + }, + "VirtualMachineScaleSetVMExtensionUpdate": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a VMSS VM Extension.", + "x-ms-azure-resource": true + }, + "VirtualMachineScaleSetVMExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtension" + }, + "description": "The list of VMSS VM extensions" + } + }, + "description": "The List VMSS VM Extension operation response" + }, + "VirtualMachineScaleSetHardwareProfile": { + "type": "object", + "properties": { + "vmSizeProperties": { + "$ref": "./computeRPCommon.json#/definitions/VMSizeProperties", + "description": "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." + } + }, + "description": "Specifies the hardware settings for the virtual machine scale set." + }, + "AutomaticRepairsPolicy": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." + }, + "gracePeriod": { + "type": "string", + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)." + }, + "repairAction": { + "type": "string", + "description": "Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.", + "enum": [ + "Replace", + "Restart", + "Reimage" + ], + "x-ms-enum": { + "name": "RepairAction", + "modelAsString": true + } + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "AutomaticOSUpgradePolicy": { + "properties": { + "enableAutomaticOSUpgrade": { + "type": "boolean", + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." + }, + "disableAutomaticRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled. Default value is false." + }, + "useRollingUpgradePolicy": { + "type": "boolean", + "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS." + }, + "osRollingUpgradeDeferral": { + "type": "boolean", + "description": "Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "UpgradePolicy": { + "properties": { + "mode": { + "type": "string", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false + } + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "automaticOSUpgradePolicy": { + "$ref": "#/definitions/AutomaticOSUpgradePolicy", + "description": "Configuration parameters used for performing automatic OS Upgrade." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "ResiliencyPolicy": { + "type": "object", + "properties": { + "resilientVMCreationPolicy": { + "$ref": "#/definitions/ResilientVMCreationPolicy", + "description": "The configuration parameters used while performing resilient VM creation." + }, + "resilientVMDeletionPolicy": { + "$ref": "#/definitions/ResilientVMDeletionPolicy", + "description": "The configuration parameters used while performing resilient VM deletion." + } + }, + "description": "Describes an resiliency policy - resilientVMCreationPolicy and/or resilientVMDeletionPolicy." + }, + "ResilientVMCreationPolicy": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false." + } + }, + "description": "The configuration parameters used while performing resilient VM creation." + }, + "ResilientVMDeletionPolicy": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false." + } + }, + "description": "The configuration parameters used while performing resilient VM deletion." + }, + "RollingUpgradePolicy": { + "properties": { + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + }, + "enableCrossZoneUpgrade": { + "type": "boolean", + "description": "Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size." + }, + "prioritizeUnhealthyInstances": { + "type": "boolean", + "description": "Upgrade all unhealthy instances in a scale set before any healthy instances." + }, + "rollbackFailedInstancesOnPolicyBreach": { + "type": "boolean", + "description": "Rollback failed instances to previous model if the Rolling Upgrade policy is violated." + }, + "maxSurge": { + "type": "boolean", + "description": "Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "ScaleInPolicy": { + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Default", + "OldestVM", + "NewestVM" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetScaleInRules", + "modelAsString": true + } + }, + "description": "The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

" + }, + "forceDeletion": { + "type": "boolean", + "description": "This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)" + } + }, + "description": "Describes a scale-in policy for a virtual machine scale set." + }, + "SpotRestorePolicy": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints" + }, + "restoreTimeout": { + "type": "string", + "description": "Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances" + } + }, + "description": "Specifies the Spot-Try-Restore properties for the virtual machine scale set. With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint." + }, + "PriorityMixPolicy": { + "type": "object", + "properties": { + "baseRegularPriorityCount": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The base number of regular priority VMs that will be created in this scale set as it scales out." + }, + "regularPriorityPercentageAboveBase": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority." + } + }, + "description": "Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached." + }, + "OrchestrationMode": { + "type": "string", + "description": "Specifies the orchestration mode for the virtual machine scale set.", + "enum": [ + "Uniform", + "Flexible" + ], + "x-ms-enum": { + "name": "OrchestrationMode", + "modelAsString": true + } + }, + "VirtualMachineScaleSetIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "$ref": "../../../common-types/v1/common.json#/definitions/UserAssignedIdentities", + "description": "The list of user identities associated with the virtual machine scale 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": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetOSProfile": { + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "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." + }, + "adminUsername": { + "type": "string", + "description": "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" + }, + "adminPassword": { + "type": "string", + "description": "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)", + "x-ms-secret": true + }, + "customData": { + "type": "string", + "description": "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)" + }, + "windowsConfiguration": { + "$ref": "./computeRPCommon.json#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "./computeRPCommon.json#/definitions/LinuxConfiguration", + "description": "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)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ], + "description": "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)." + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "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." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Optional property which must either be set to True or omitted." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetUpdateOSProfile": { + "properties": { + "customData": { + "type": "string", + "description": "A base-64 encoded string of custom data." + }, + "windowsConfiguration": { + "$ref": "./computeRPCommon.json#/definitions/WindowsConfiguration", + "description": "The Windows Configuration of the OS profile." + }, + "linuxConfiguration": { + "$ref": "./computeRPCommon.json#/definitions/LinuxConfiguration", + "description": "The Linux Configuration of the OS profile." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ], + "description": "The List of certificates for addition to the VM." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "./computeRPCommon.json#/definitions/StorageAccountType", + "description": "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." + }, + "diskEncryptionSet": { + "$ref": "./computeRPCommon.json#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk." + }, + "securityProfile": { + "$ref": "./computeRPCommon.json#/definitions/VMDiskSecurityProfile", + "description": "Specifies the security profile for the managed disk." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetOSDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "./computeRPCommon.json#/definitions/Caching", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "./computeRPCommon.json#/definitions/CreateOption", + "description": "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." + }, + "diffDiskSettings": { + "$ref": "./computeRPCommon.json#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "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." + }, + "osType": { + "type": "string", + "description": "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.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "image": { + "$ref": "./computeRPCommon.json#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + "deleteOption": { + "$ref": "./computeRPCommon.json#/definitions/DeleteOption", + "description": "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." + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetUpdateOSDisk": { + "properties": { + "caching": { + "$ref": "./computeRPCommon.json#/definitions/Caching", + "description": "The caching type." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "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.

diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023" + }, + "image": { + "$ref": "./computeRPCommon.json#/definitions/VirtualHardDisk", + "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual hard disk container uris." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + "deleteOption": { + "$ref": "./computeRPCommon.json#/definitions/DeleteOption", + "description": "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." + } + }, + "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk." + }, + "VirtualMachineScaleSetDataDisk": { + "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 identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "caching": { + "$ref": "./computeRPCommon.json#/definitions/Caching", + "description": "Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "./computeRPCommon.json#/definitions/CreateOption", + "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 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." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "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." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "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." + }, + "deleteOption": { + "$ref": "./computeRPCommon.json#/definitions/DeleteOption", + "description": "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**." + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetStorageProfile": { + "properties": { + "imageReference": { + "$ref": "./computeRPCommon.json#/definitions/ImageReference", + "description": "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." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "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)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "x-ms-identifiers": [ + "name", + "lun" + ], + "description": "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)." + }, + "diskControllerType": { + "type": "string", + "items": { + "$ref": "./computeRPCommon.json#/definitions/DiskControllerType", + "description": "Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01" + } + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetUpdateStorageProfile": { + "properties": { + "imageReference": { + "$ref": "./computeRPCommon.json#/definitions/ImageReference", + "description": "The image reference." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", + "description": "The OS disk." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "x-ms-identifiers": [ + "name", + "lun" + ], + "description": "The data disks." + }, + "diskControllerType": { + "type": "string", + "items": { + "$ref": "./computeRPCommon.json#/definitions/DiskControllerType", + "description": "Specifies the disk controller type configured for the virtual machines in the scale set. **Note:** You need to deallocate the virtual machines in the scale set before updating its disk controller type based on the upgrade mode configured for the scale set. Minimum api-version: 2022-08-01." + } + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "./computeRPCommon.json#/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 than 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "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'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "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." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "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." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "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." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetUpdateIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "The subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "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'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "The application gateway backend address pools." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource" + }, + "description": "The load balancer inbound nat pools." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties" + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network", + "x-ms-azure-resource": true + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 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": "../../../common-types/v1/common.json#/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", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies the IP configurations of the network interface." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + }, + "deleteOption": { + "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 + } + }, + "auxiliaryMode": { + "type": "string", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface resource.", + "enum": [ + "None", + "AcceleratedConnections", + "Floating" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true + } + }, + "auxiliarySku": { + "type": "string", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface resource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true + } + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Whether this is a primary NIC on a virtual machine." + }, + "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": "../../../common-types/v1/common.json#/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", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The virtual machine scale set IP Configuration." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + }, + "deleteOption": { + "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 + } + }, + "auxiliaryMode": { + "type": "string", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface resource.", + "enum": [ + "None", + "AcceleratedConnections", + "Floating" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true + } + }, + "auxiliarySku": { + "type": "string", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface resource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetUpdateNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties" + } + }, + "description": "Describes a virtual machine scale set network profile's network configurations.", + "x-ms-azure-resource": true + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "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" + }, + "domainNameLabelScope": { + "type": "string", + "description": "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", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "DomainNameLabelScopeTypes", + "modelAsString": true + } + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetIpTag": { + "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." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/PublicIPAddressSku" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties" + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "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", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "x-ms-identifiers": [], + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPPrefix": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "publicIPAddressVersion": { + "type": "string", + "description": "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'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the public IP when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": { + "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 ." + }, + "publicIPPrefix": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the public IP when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "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}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "x-ms-identifiers": [], + "description": "The list of network configurations." + }, + "networkApiVersion": { + "type": "string", + "description": "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'", + "enum": [ + "2020-11-01" + ], + "x-ms-enum": { + "name": "NetworkApiVersion", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetUpdateNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "./computeRPCommon.json#/definitions/ApiEntityReference", + "description": "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}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of network configurations." + }, + "networkApiVersion": { + "type": "string", + "description": "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'", + "enum": [ + "2020-11-01" + ], + "x-ms-enum": { + "name": "NetworkApiVersion", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "suppressFailures": { + "type": "boolean", + "description": "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." + }, + "protectedSettingsFromKeyVault": { + "$ref": "./computeRPCommon.json#/definitions/KeyVaultSecretReference", + "description": "The extensions protected settings that are passed by reference, and consumed from key vault" + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtension": { + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionUpdate": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension.", + "x-ms-azure-resource": true + }, + "VirtualMachineScaleSetExtensionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The list of VM scale set extensions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions." + } + }, + "required": [ + "value" + ], + "description": "The List VM scale set extension operation response." + }, + "VirtualMachineScaleSetExtensionProfile": { + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The virtual machine scale set child extension resources." + }, + "extensionsTimeBudget": { + "type": "string", + "description": "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." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale set." + }, + "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 scale set." + }, + "securityProfile": { + "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machines in the scale set." + }, + "diagnosticsProfile": { + "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." + }, + "licenseType": { + "type": "string", + "description": "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" + }, + "priority": { + "$ref": "./computeRPCommon.json#/definitions/priority", + "description": "Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview." + }, + "evictionPolicy": { + "$ref": "./computeRPCommon.json#/definitions/evictionPolicy", + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "billingProfile": { + "$ref": "./computeRPCommon.json#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01." + }, + "scheduledEventsProfile": { + "$ref": "./computeRPCommon.json#/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 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01." + }, + "capacityReservation": { + "$ref": "./computeRPCommon.json#/definitions/CapacityReservationProfile", + "description": "Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01." + }, + "applicationProfile": { + "$ref": "./computeRPCommon.json#/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 api-version: 2021-11-01." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReference", + "description": "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" + }, + "securityPostureReference": { + "$ref": "#/definitions/SecurityPostureReference", + "description": "Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01" + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "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." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetUpdateVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile", + "description": "The virtual machine scale set OS profile." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile", + "description": "The virtual machine scale set storage profile." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", + "description": "The virtual machine scale set network profile." + }, + "securityProfile": { + "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", + "description": "The virtual machine scale set Security profile" + }, + "diagnosticsProfile": { + "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", + "description": "The virtual machine scale set diagnostics profile." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "The virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "The license type, which is for bring your own license scenario." + }, + "billingProfile": { + "$ref": "./computeRPCommon.json#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01." + }, + "scheduledEventsProfile": { + "$ref": "./computeRPCommon.json#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + }, + "userData": { + "type": "string", + "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

Minimum api-version: 2021-03-01" + }, + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile", + "description": "Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", + "description": "The virtual machine profile." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "uniqueId": { + "readOnly": true, + "type": "string", + "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true." + }, + "zoneBalance": { + "type": "boolean", + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count for each placement group." + }, + "proximityPlacementGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01." + }, + "hostGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01." + }, + "additionalCapabilities": { + "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "scaleInPolicy": { + "$ref": "#/definitions/ScaleInPolicy", + "description": "Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set." + }, + "orchestrationMode": { + "$ref": "#/definitions/OrchestrationMode", + "description": "Specifies the orchestration mode for the virtual machine scale set." + }, + "spotRestorePolicy": { + "$ref": "#/definitions/SpotRestorePolicy", + "description": "Specifies the Spot Restore properties for the virtual machine scale set." + }, + "priorityMixPolicy": { + "$ref": "#/definitions/PriorityMixPolicy", + "description": "Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01." + }, + "constrainedMaximumCapacity": { + "type": "boolean", + "description": "Optional property which must either be set to True or omitted." + }, + "resiliencyPolicy": { + "$ref": "#/definitions/ResiliencyPolicy", + "description": "Policy for Resiliency" + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdateProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", + "description": "The virtual machine profile." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true." + }, + "additionalCapabilities": { + "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "scaleInPolicy": { + "$ref": "#/definitions/ScaleInPolicy", + "description": "Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set." + }, + "proximityPlacementGroup": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01." + }, + "priorityMixPolicy": { + "$ref": "#/definitions/PriorityMixPolicy", + "description": "Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance." + }, + "spotRestorePolicy": { + "$ref": "#/definitions/SpotRestorePolicy", + "description": "Specifies the Spot Restore properties for the virtual machine scale set." + }, + "resiliencyPolicy": { + "$ref": "#/definitions/ResiliencyPolicy", + "description": "Policy for Resiliency" + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSet": { + "properties": { + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "./computeRPCommon.json#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set" + }, + "extendedLocation": { + "$ref": "../../../common-types/v1/common.json#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine Scale Set." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMReimageParameters": { + "allOf": [ + { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetReimageParameters": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetUpdate": { + "properties": { + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "./computeRPCommon.json#/definitions/Plan", + "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + } + }, + "allOf": [ + { + "$ref": "./computeRPCommon.json#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMInstanceIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineScaleSetVMInstanceRequiredIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids." + } + }, + "required": [ + "instanceIds" + ], + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineStatusCodeCount": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The instance view status code." + }, + "count": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances having a particular status code." + } + }, + "description": "The status code and count of the virtual machine scale set instance view status summary." + }, + "VirtualMachineScaleSetInstanceViewStatusesSummary": { + "properties": { + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "x-ms-identifiers": [], + "description": "The extensions information." + } + }, + "description": "Instance view statuses summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetVMExtensionsSummary": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The extension name." + }, + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "x-ms-identifiers": [], + "description": "The extensions information." + } + }, + "description": "Extensions summary for virtual machines of a virtual machine scale set." + }, + "OrchestrationServiceSummary": { + "properties": { + "serviceName": { + "type": "string", + "readOnly": true, + "description": "The name of the service.", + "enum": [ + "AutomaticRepairs" + ], + "x-ms-enum": { + "name": "OrchestrationServiceNames", + "modelAsString": true + } + }, + "serviceState": { + "type": "string", + "readOnly": true, + "description": "The current state of the service.", + "enum": [ + "NotRunning", + "Running", + "Suspended" + ], + "x-ms-enum": { + "name": "OrchestrationServiceState", + "modelAsString": true + } + } + }, + "description": "Summary for an orchestration service of a virtual machine scale set." + }, + "VirtualMachineScaleSetInstanceView": { + "properties": { + "virtualMachine": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary", + "readOnly": true, + "description": "The instance view status summary for the virtual machine scale set." + }, + "extensions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The extensions information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + }, + "orchestrationServices": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/OrchestrationServiceSummary" + }, + "x-ms-identifiers": [ + "serviceName" + ], + "description": "The orchestration services information." + } + }, + "description": "The instance view of a virtual machine scale set." + }, + "VirtualMachineScaleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetListWithLinkResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetSkuCapacity": { + "properties": { + "minimum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum capacity that can be set." + }, + "defaultCapacity": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "readOnly": true, + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "None" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetSkuScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a sku." + }, + "VirtualMachineScaleSetSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the sku applies to." + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "readOnly": true, + "description": "The Sku." + }, + "capacity": { + "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes an available virtual machine scale set sku." + }, + "VirtualMachineScaleSetListSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetSku" + }, + "x-ms-identifiers": [ + "resourceType", + "sku/name" + ], + "description": "The list of skus available for the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus." + } + }, + "required": [ + "value" + ], + "description": "The Virtual Machine Scale Set List Skus operation response." + }, + "UpgradeOperationHistoryStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "UpgradeState", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "UpgradeOperationHistoricalStatusInfoProperties": { + "properties": { + "runningStatus": { + "$ref": "#/definitions/UpgradeOperationHistoryStatus", + "readOnly": true, + "description": "Information about the overall status of the upgrade operation." + }, + "progress": { + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "readOnly": true, + "description": "Counts of the VMs in each state." + }, + "error": { + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "readOnly": true, + "description": "Error Details for this upgrade if there are any." + }, + "startedBy": { + "readOnly": true, + "type": "string", + "description": "Invoker of the Upgrade Operation", + "enum": [ + "Unknown", + "User", + "Platform" + ], + "x-ms-enum": { + "name": "UpgradeOperationInvoker", + "modelAsString": false + } + }, + "targetImageReference": { + "$ref": "./computeRPCommon.json#/definitions/ImageReference", + "readOnly": true, + "description": "Image Reference details" + }, + "rollbackInfo": { + "$ref": "./computeRPCommon.json#/definitions/RollbackStatusInfo", + "readOnly": true, + "description": "Information about OS rollback if performed" + } + }, + "description": "Describes each OS upgrade on the Virtual Machine Scale Set." + }, + "UpgradeOperationHistoricalStatusInfo": { + "properties": { + "properties": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties", + "readOnly": true, + "description": "Information about the properties of the upgrade operation." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + } + }, + "description": "Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetListOSUpgradeHistory": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo" + }, + "x-ms-identifiers": [ + "type", + "location" + ], + "description": "The list of OS upgrades performed on the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades." + } + }, + "required": [ + "value" + ], + "description": "List of Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetVMProperties": { + "properties": { + "latestModelApplied": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the latest model has been applied to the virtual machine." + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Azure VM unique ID." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "hardwareProfile": { + "$ref": "./computeRPCommon.json#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "./computeRPCommon.json#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "./computeRPCommon.json#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "osProfile": { + "$ref": "./computeRPCommon.json#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "securityProfile": { + "$ref": "./computeRPCommon.json#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machine." + }, + "networkProfile": { + "$ref": "./computeRPCommon.json#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "networkProfileConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetVMNetworkProfileConfiguration", + "description": "Specifies the network profile configuration of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "./computeRPCommon.json#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "../../../common-types/v1/common.json#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Availability sets overview](https://docs.microsoft.com/azure/virtual-machines/availability-set-overview). For more information on Azure planned maintenance, see [Maintenance and updates for Virtual Machines in Azure](https://docs.microsoft.com/azure/virtual-machines/maintenance-and-updates). Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "licenseType": { + "type": "string", + "description": "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" + }, + "modelDefinitionApplied": { + "readOnly": true, + "type": "string", + "description": "Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine." + }, + "protectionPolicy": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy", + "description": "Specifies the protection policy of the virtual machine." + }, + "userData": { + "type": "string", + "description": "UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here.

Minimum api-version: 2021-03-01" + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Virtual Machine resource was created.

Minimum api-version: 2021-11-01." + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVM": { + "properties": { + "instanceId": { + "readOnly": true, + "type": "string", + "description": "The virtual machine instance ID." + }, + "sku": { + "$ref": "./computeRPCommon.json#/definitions/Sku", + "readOnly": true, + "description": "The virtual machine SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + "plan": { + "$ref": "./computeRPCommon.json#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + }, + "identity": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Etag is property returned in Update/Get response of the VMSS VM, so that customer can supply it in the header to ensure optimistic updates." + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Describes a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVMInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "The Update Domain count." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "The Fault Domain count." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "./computeRPCommon.json#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/DiskInstanceView" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The disks information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtensionInstanceView" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "./virtualMachine.json#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "./computeRPCommon.json#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "./computeRPCommon.json#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [], + "description": "The resource status information." + }, + "assignedHost": { + "type": "string", + "readOnly": true, + "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01." + }, + "placementGroupId": { + "type": "string", + "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId." + }, + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

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

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

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "osName": { + "type": "string", + "description": "The Operating System running on the hybrid machine." + }, + "osVersion": { + "type": "string", + "description": "The version of Operating System running on the hybrid machine." + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + } + }, + "description": "The instance view of a virtual machine scale set VM." + }, + "VirtualMachineScaleSetVMNetworkProfileConfiguration": { + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set VM network profile." + }, + "VirtualMachineScaleSetVMProtectionPolicy": { + "properties": { + "protectFromScaleIn": { + "type": "boolean", + "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation." + }, + "protectFromScaleSetActions": { + "type": "boolean", + "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM." + } + }, + "description": "The protection policy of a virtual machine scale set VM." + }, + "VirtualMachineScaleSetVMListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "The list of virtual machine scale sets VMs." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs" + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine Scale Set VMs operation response." + }, + "RollingUpgradeStatusInfo": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RollingUpgradeStatusInfoProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeStatusInfoProperties": { + "properties": { + "policy": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The rolling upgrade policies applied for this upgrade." + }, + "runningStatus": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeRunningStatus", + "description": "Information about the current running state of the overall upgrade." + }, + "progress": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "error": { + "readOnly": true, + "$ref": "../../../common-types/v1/common.json#/definitions/ApiError", + "description": "Error details for this upgrade, if there are any." + } + }, + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeRunningStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "RollingUpgradeStatusCode", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "lastAction": { + "type": "string", + "readOnly": true, + "description": "The last action performed on the rolling upgrade.", + "enum": [ + "Start", + "Cancel" + ], + "x-ms-enum": { + "name": "RollingUpgradeActionType", + "modelAsString": false + } + }, + "lastActionTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last action time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "RollingUpgradeProgressInfo": { + "properties": { + "successfulInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have been successfully upgraded." + }, + "failedInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have failed to be upgraded successfully." + }, + "inProgressInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that are currently being upgraded." + }, + "pendingInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have not yet begun to be upgraded." + } + }, + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "RecoveryWalkResponse": { + "properties": { + "walkPerformed": { + "type": "boolean", + "readOnly": true, + "description": "Whether the recovery walk was performed" + }, + "nextPlatformUpdateDomain": { + "type": "integer", + "readOnly": true, + "description": "The next update domain that needs to be walked. Null means walk spanning all update domains has been completed" + } + }, + "description": "Response after calling a manual recovery walk" + }, + "VMScaleSetConvertToSinglePlacementGroupInput": { + "properties": { + "activePlacementGroupId": { + "type": "string", + "description": "Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances." + } + } + }, + "OrchestrationServiceStateInput": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service.", + "enum": [ + "AutomaticRepairs" + ], + "x-ms-enum": { + "name": "OrchestrationServiceNames", + "modelAsString": true + } + }, + "action": { + "type": "string", + "description": "The action to be performed.", + "enum": [ + "Resume", + "Suspend" + ], + "x-ms-enum": { + "name": "OrchestrationServiceStateAction", + "modelAsString": true + } + } + }, + "description": "The input for OrchestrationServiceState", + "required": [ + "serviceName", + "action" + ] + }, + "ServiceArtifactReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + }, + "description": "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" + }, + "SecurityPostureReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + }, + "excludeExtensions": { + "type": "array", + "items": { + "$ref": "./virtualMachine.json#/definitions/VirtualMachineExtension" + }, + "description": "List of virtual machine extensions to exclude when applying the Security Posture." + } + }, + "description": "Specifies the security posture to be used for all virtual machines in the scale set. Minimum api-version: 2023-03-01" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json new file mode 100644 index 000000000000..8e90e1ce8905 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json @@ -0,0 +1,615 @@ +{ + "swagger": "2.0", + "info": { + "title": "CommunityGalleryServiceClient", + "description": "Community Gallery Service Client.", + "version": "2022-08-03" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}": { + "get": { + "tags": [ + "CommunityGalleries" + ], + "operationId": "CommunityGalleries_Get", + "description": "Get a community gallery by gallery public name.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "#/parameters/PublicGalleryNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommunityGallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a community gallery.": { + "$ref": "./examples/communityGalleryExamples/CommunityGallery_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}": { + "get": { + "tags": [ + "CommunityGalleryImages" + ], + "operationId": "CommunityGalleryImages_Get", + "description": "Get a community gallery image.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PublicGalleryNameParameter" + }, + { + "$ref": "#/parameters/GalleryImageNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommunityGalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a community gallery image.": { + "$ref": "./examples/communityGalleryExamples/CommunityGalleryImage_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}": { + "get": { + "tags": [ + "CommunityGalleryImageVersions" + ], + "operationId": "CommunityGalleryImageVersions_Get", + "description": "Get a community gallery image version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PublicGalleryNameParameter" + }, + { + "$ref": "#/parameters/GalleryImageNameParameter" + }, + { + "$ref": "#/parameters/GalleryImageVersionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommunityGalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a community gallery image version.": { + "$ref": "./examples/communityGalleryExamples/CommunityGalleryImageVersion_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images": { + "get": { + "tags": [ + "CommunityGalleryImages" + ], + "operationId": "CommunityGalleryImages_List", + "description": "List community gallery images inside a gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PublicGalleryNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommunityGalleryImageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List community gallery images.": { + "$ref": "./examples/communityGalleryExamples/CommunityGalleryImage_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions": { + "get": { + "tags": [ + "CommunityGalleryImageVersions" + ], + "operationId": "CommunityGalleryImageVersions_List", + "description": "List community gallery image versions inside an image.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/PublicGalleryNameParameter" + }, + { + "$ref": "#/parameters/GalleryImageNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommunityGalleryImageVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List community gallery image versions.": { + "$ref": "./examples/communityGalleryExamples/CommunityGalleryImageVersion_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PirCommunityGalleryResource": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "identifier": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommunityGalleryIdentifier" + } + }, + "description": "Base information about the community gallery resource in azure compute gallery." + }, + "CommunityGalleryArtifactTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The artifact tags of a community gallery resource." + }, + "CommunityGalleryDisclaimer": { + "type": "string", + "properties": { + "disclaimer": { + "readOnly": true, + "type": "string", + "description": "Community gallery disclaimer" + } + }, + "description": "The disclaimer for a community gallery resource." + }, + "CommunityGalleryIdentifier": { + "properties": { + "uniqueId": { + "type": "string", + "description": "The unique id of this community gallery." + } + }, + "description": "The identifier information of community gallery." + }, + "CommunityGalleryMetadata": { + "type": "object", + "properties": { + "publisherUri": { + "format": "uri", + "type": "string", + "description": "The publisher URI of this community gallery." + }, + "publisherContact": { + "type": "string", + "description": "The publisher email id of this community gallery." + }, + "eula": { + "type": "string", + "description": "The end-user license agreement for this community gallery." + }, + "publicNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of public names the gallery has." + }, + "privacyStatementUri": { + "format": "uri", + "type": "string", + "description": "The link for the privacy statement of this community gallery from the gallery publisher." + } + }, + "required": [ + "publisherContact", + "publicNames" + ], + "description": "The metadata of community gallery." + }, + "CommunityGallery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommunityGalleryProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirCommunityGalleryResource" + } + ], + "description": "Specifies information about the Community Gallery that you want to create or update." + }, + "CommunityGalleryProperties": { + "type": "object", + "properties": { + "disclaimer": { + "$ref": "#/definitions/CommunityGalleryDisclaimer" + }, + "artifactTags": { + "$ref": "#/definitions/CommunityGalleryArtifactTags" + }, + "communityMetadata": { + "$ref": "#/definitions/CommunityGalleryMetadata" + } + }, + "description": "Describes the properties of a community gallery." + }, + "CommunityGalleryImageList": { + "type": "object", + "description": "The List Community Gallery Images operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CommunityGalleryImage" + }, + "x-ms-identifiers": [], + "description": "A list of community gallery images." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of community gallery images. Call ListNext() with this to fetch the next page of community gallery images." + } + }, + "required": [ + "value" + ] + }, + "CommunityGalleryImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommunityGalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirCommunityGalleryResource" + } + ], + "description": "Specifies information about the gallery image definition that you want to create or update." + }, + "CommunityGalleryImageProperties": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "identifier": { + "$ref": "#/definitions/CommunityGalleryImageIdentifier" + }, + "recommended": { + "$ref": "./galleryRPCommon.json#/definitions/RecommendedMachineConfiguration" + }, + "disallowed": { + "$ref": "./galleryRPCommon.json#/definitions/Disallowed" + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "features": { + "type": "array", + "items": { + "$ref": "./galleryRPCommon.json#/definitions/GalleryImageFeature" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of gallery image features." + }, + "purchasePlan": { + "$ref": "./galleryRPCommon.json#/definitions/ImagePurchasePlan" + }, + "architecture": { + "$ref": "./galleryRPCommon.json#/definitions/Architecture" + }, + "privacyStatementUri": { + "type": "string", + "description": "Privacy statement URI for the current community gallery image." + }, + "eula": { + "type": "string", + "description": "The end-user license agreement for the current community gallery image." + }, + "disclaimer": { + "$ref": "#/definitions/CommunityGalleryDisclaimer" + }, + "artifactTags": { + "$ref": "#/definitions/CommunityGalleryArtifactTags" + } + }, + "required": [ + "osType", + "osState", + "identifier" + ], + "description": "Describes the properties of a gallery image definition." + }, + "CommunityGalleryImageVersionList": { + "type": "object", + "description": "The List Community Gallery Image versions operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CommunityGalleryImageVersion" + }, + "x-ms-identifiers": [], + "description": "A list of community gallery image versions." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of community gallery image versions. Call ListNext() with this to fetch the next page of community gallery image versions." + } + }, + "required": [ + "value" + ] + }, + "CommunityGalleryImageVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CommunityGalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirCommunityGalleryResource" + } + ], + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "CommunityGalleryImageVersionProperties": { + "properties": { + "publishedDate": { + "type": "string", + "format": "date-time", + "description": "The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { + "type": "boolean", + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "storageProfile": { + "$ref": "./galleryRPCommon.json#/definitions/SharedGalleryImageVersionStorageProfile", + "description": "Describes the storage profile of the image version." + }, + "disclaimer": { + "$ref": "#/definitions/CommunityGalleryDisclaimer" + }, + "artifactTags": { + "$ref": "#/definitions/CommunityGalleryArtifactTags" + } + }, + "description": "Describes the properties of a gallery image version." + }, + "CommunityGalleryImageIdentifier": { + "properties": { + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "description": "This is the community gallery image definition identifier." + } + }, + "parameters": { + "PublicGalleryNameParameter": { + "name": "publicGalleryName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The public name of the community gallery." + }, + "GalleryImageNameParameter": { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the community gallery image definition." + }, + "GalleryImageVersionNameParameter": { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the community gallery image version. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_Get.json new file mode 100644 index 000000000000..6e81a12f9b99 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03", + "publicGalleryName": "publicGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "myGalleryImageVersionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishedDate": "2018-03-20T09:12:28Z", + "endOfLifeDate": "2022-03-20T09:12:28Z", + "excludeFromLatest": false, + "storageProfile": { + "osDiskImage": { + "diskSizeGB": 29, + "hostCaching": "None" + } + }, + "artifactTags": { + "ShareTag-CommunityGallery": "CommunityGallery" + }, + "disclaimer": "https://test-uri.com" + }, + "location": "myLocation", + "name": "myGalleryImageVersionName", + "type": "Microsoft.Compute/locations/communityGalleryImageVersion", + "identifier": { + "uniqueId": "/CommunityGalleries/publicGalleryName/Images/myGalleryImageName/Versions/myGalleryImageVersionName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_List.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_List.json new file mode 100644 index 000000000000..fb84f4aa715c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImageVersion_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03", + "publicGalleryName": "publicGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "publishedDate": "2018-03-20T09:12:28Z", + "endOfLifeDate": "2022-03-20T09:12:28Z", + "excludeFromLatest": false, + "storageProfile": { + "osDiskImage": { + "diskSizeGB": 29, + "hostCaching": "None" + } + }, + "artifactTags": { + "ShareTag-CommunityGallery": "CommunityGallery" + }, + "disclaimer": "https://test-uri.com" + }, + "location": "myLocation", + "name": "myGalleryImageVersionName", + "identifier": { + "uniqueId": "/CommunityGalleries/publicGalleryName/Images/myGalleryImageName/Versions/myGalleryImageVersionName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscription-Id}/providers/Microsoft.Compute/communityGalleries/publicGalleryName/images/myGalleryImageName/versions?$skiptoken={token}/communityGalleries/publicGalleryName/images/myGalleryImageName/versions/myGalleryImageVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json new file mode 100644 index 000000000000..62d50230d938 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImage_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03", + "publicGalleryName": "publicGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "privacyStatementUri": "https://test-uri.com", + "eula": "https://test-uri.com", + "artifactTags": { + "ShareTag-CommunityGallery": "CommunityGallery" + }, + "disclaimer": "https://test-uri.com" + }, + "location": "myLocation", + "name": "myGalleryImageName", + "type": "Microsoft.Compute/locations/communityGalleryImage", + "identifier": { + "uniqueId": "/CommunityGalleries/publicGalleryName/Images/myGalleryImageName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImage_List.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImage_List.json new file mode 100644 index 000000000000..768c3a2fea82 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGalleryImage_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03", + "publicGalleryName": "publicGalleryName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "artifactTags": { + "ShareTag-CommunityGallery": "CommunityGallery" + }, + "disclaimer": "https://test-uri.com" + }, + "location": "myLocation", + "name": "myGalleryImageName", + "identifier": { + "uniqueId": "/CommunityGalleries/publicGalleryName/Images/myGalleryImageName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscription-Id}/providers/Microsoft.Compute/communityGalleries/publicGalleryName/images?$skiptoken={token}/communityGalleries/publicGalleryName/images/myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGallery_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGallery_Get.json new file mode 100644 index 000000000000..c1390e1d83c8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/communityGalleryExamples/CommunityGallery_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03", + "publicGalleryName": "publicGalleryName" + }, + "responses": { + "200": { + "body": { + "location": "myLocation", + "name": "publicGalleryName", + "type": "Microsoft.Compute/locations/communityGallery", + "identifier": { + "uniqueId": "/CommunityGalleries/publicGalleryName" + }, + "properties": { + "artifactTags": { + "ShareTag-CommunityGallery": "CommunityGallery" + }, + "disclaimer": "https://test-uri.com", + "communityMetadata": { + "publisherUri": "https://test-uri.com", + "publisherContact": "sameple@email.com", + "eula": "https://test-uri.com", + "publicNames": [ + "prefix-xxxxx" + ], + "privacyStatementUri": "https://test-uri.com" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/CommunityGallery_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/CommunityGallery_Create.json new file mode 100644 index 000000000000..7ca3bf91b135 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/CommunityGallery_Create.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description.", + "sharingProfile": { + "permissions": "Community", + "communityGalleryInfo": { + "publisherUri": "uri", + "publisherContact": "pir@microsoft.com", + "eula": "eula", + "publicNamePrefix": "PirPublic" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "sharingProfile": { + "permissions": "Community", + "communityGalleryInfo": { + "publisherUri": "uri", + "publisherContact": "pir@microsoft.com", + "eula": "eula", + "publicNamePrefix": "PirPublic" + } + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating", + "sharingProfile": { + "permissions": "Community", + "communityGalleryInfo": { + "publisherUri": "uri", + "publisherContact": "pir@microsoft.com", + "eula": "eula", + "publicNamePrefix": "PirPublic" + } + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "sharingProfile": { + "permissions": "Community", + "communityGalleryInfo": { + "publisherUri": "uri", + "publisherContact": "pir@microsoft.com", + "eula": "eula", + "publicNamePrefix": "PirPublic" + } + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/CommunityGallery_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/CommunityGallery_Get.json new file mode 100644 index 000000000000..ae89f146e9d9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/CommunityGallery_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/communityGalleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded", + "sharingProfile": { + "permissions": "Community", + "communityGalleryInfo": { + "publisherUri": "uri", + "publisherContact": "pir@microsoft.com", + "eula": "eula", + "publicNames": [ + "GalleryPublicName" + ], + "communityGalleryEnabled": true + } + }, + "sharingStatus": { + "aggregatedState": "Succeeded", + "summary": [ + { + "region": "westus", + "state": "Succeeded", + "details": "" + } + ] + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Create.json new file mode 100644 index 000000000000..0b923fed4e95 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Create.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0", + "galleryApplicationVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "endOfLifeDate": "2019-07-01T07:00:00Z", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "settings": { + "packageFileName": "package.zip", + "configFileName": "configuration.cfg" + }, + "advancedSettings": { + "timeout": "300", + "user": "root" + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "settings": { + "packageFileName": "package.zip", + "configFileName": "configuration.cfg" + }, + "advancedSettings": { + "timeout": "300", + "user": "root" + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Creating" + } + } + }, + "202": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Delete.json new file mode 100644 index 000000000000..55845444b457 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Delete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Get.json new file mode 100644 index 000000000000..47c36db0d7a2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Get_WithReplicationStatus.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Get_WithReplicationStatus.json new file mode 100644 index 000000000000..c2c48189a123 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Get_WithReplicationStatus.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0", + "$expand": "ReplicationStatus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "settings": { + "packageFileName": "package.zip", + "configFileName": "configuration.cfg" + }, + "advancedSettings": { + "timeout": "300", + "user": "root" + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "replicationStatus": { + "aggregatedState": "Completed", + "summary": [ + { + "region": "West US", + "state": "Completed", + "details": "", + "progress": 100 + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_ListByGalleryApplication.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_ListByGalleryApplication.json new file mode 100644 index 000000000000..df301df6830e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_ListByGalleryApplication.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/applications/myGalleryApplicationName/versions/myGalleryApplicationVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Update.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Update.json new file mode 100644 index 000000000000..4fcc102129c6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplicationVersion_Update.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0", + "galleryApplicationVersion": { + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "endOfLifeDate": "2019-07-01T07:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "manageActions": { + "install": "powershell -command \"Expand-Archive -Path package.zip -DestinationPath C:\\package\"", + "remove": "del C:\\package " + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS" + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Create.json new file mode 100644 index 000000000000..e1a919e1e367 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Create.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplication": { + "location": "West US", + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + }, + "201": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + }, + "202": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Delete.json new file mode 100644 index 000000000000..9e17ed1974fd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-07-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-07-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Get.json new file mode 100644 index 000000000000..52470ce216c6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName", + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_ListByGallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_ListByGallery.json new file mode 100644 index 000000000000..83092bb1c6ba --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_ListByGallery.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName", + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/applications/myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Update.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Update.json new file mode 100644 index 000000000000..e2db23742347 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryApplication_Update.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplication": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows", + "customActions": [ + { + "name": "myCustomAction", + "script": "myCustomActionScript", + "description": "This is the custom action description.", + "parameters": [ + { + "name": "myCustomActionParameter", + "required": false, + "type": "String", + "defaultValue": "default value of parameter.", + "description": "This is the description of the parameter" + } + ] + } + ] + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create.json new file mode 100644 index 000000000000..9b2022fba862 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup//providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup//providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithCommunityImageVersionAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithCommunityImageVersionAsSource.json new file mode 100644 index 000000000000..4cf9a41269a2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithCommunityImageVersionAsSource.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "source": { + "communityGalleryImageId": "/communityGalleries/{communityGalleryName}/images/{communityGalleryImageName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "communityGalleryImageId": "/communityGalleries/{communityGalleryName}/images/{communityGalleryImageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "communityGalleryImageId": "/communityGalleries/{communityGalleryName}/images/{communityGalleryImageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "communityGalleryImageId": "/communityGalleries/{communityGalleryName}/images/{communityGalleryImageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithImageVersionAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithImageVersionAsSource.json new file mode 100644 index 000000000000..a8c39162a9a7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithImageVersionAsSource.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithShallowReplicationMode.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithShallowReplicationMode.json new file mode 100644 index 000000000000..c93d4e0049c9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithShallowReplicationMode.json @@ -0,0 +1,185 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "excludeFromLatest": false + } + ], + "replicationMode": "Shallow" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS", + "replicationMode": "Shallow" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS", + "replicationMode": "Shallow" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS", + "replicationMode": "Shallow" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json new file mode 100644 index 000000000000..edc154afb8c4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json @@ -0,0 +1,314 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{dataDiskName}" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{dataDiskName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{dataDiskName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/disks/{dataDiskName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithTargetExtendedLocations.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithTargetExtendedLocations.json new file mode 100644 index 000000000000..e8d44191a1db --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithTargetExtendedLocations.json @@ -0,0 +1,367 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "targetExtendedLocations": [ + { + "name": "West US", + "extendedLocation": { + "name": "microsoftlosangeles1", + "type": "EdgeZone" + }, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "storageAccountType": "StandardSSD_LRS(default)", + "extendedLocationReplicaCount": 1 + }, + { + "name": "East US", + "extendedLocation": { + "name": "microsoftnewyork1", + "type": "EdgeZone" + }, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "storageAccountType": "StandardSSD_LRS(default)", + "extendedLocationReplicaCount": 1 + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD.json new file mode 100644 index 000000000000..dd2a8ee2f725 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD.json @@ -0,0 +1,272 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet", + "lun": 1 + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD_UefiSettings.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD_UefiSettings.json new file mode 100644 index 000000000000..db1854d82014 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithVHD_UefiSettings.json @@ -0,0 +1,404 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet", + "lun": 1 + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + }, + "securityProfile": { + "uefiSettings": { + "signatureTemplateNames": [ + "MicrosoftUefiCertificateAuthorityTemplate" + ], + "additionalSignatures": { + "kek": [ + { + "type": "sha256", + "value": [ + "" + ] + } + ], + "db": [ + { + "type": "x509", + "value": [ + "" + ] + } + ], + "dbx": [ + { + "type": "x509", + "value": [ + "" + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "securityProfile": { + "uefiSettings": { + "signatureTemplateNames": [ + "MicrosoftUefiCertificateAuthorityTemplate" + ], + "additionalSignatures": { + "kek": [ + { + "type": "sha256", + "value": [ + "" + ] + } + ], + "db": [ + { + "type": "x509", + "value": [ + "" + ] + } + ], + "dbx": [ + { + "type": "x509", + "value": [ + "" + ] + } + ] + } + } + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "securityProfile": { + "uefiSettings": { + "signatureTemplateNames": [ + "MicrosoftUefiCertificateAuthorityTemplate" + ], + "additionalSignatures": { + "kek": [ + { + "type": "sha256", + "value": [ + "" + ] + } + ], + "db": [ + { + "type": "x509", + "value": [ + "" + ] + } + ], + "dbx": [ + { + "type": "x509", + "value": [ + "" + ] + } + ] + } + } + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "securityProfile": { + "uefiSettings": { + "signatureTemplateNames": [ + "MicrosoftUefiCertificateAuthorityTemplate" + ], + "additionalSignatures": { + "kek": [ + { + "type": "sha256", + "value": [ + "" + ] + } + ], + "db": [ + { + "type": "x509", + "value": [ + "" + ] + } + ], + "dbx": [ + { + "type": "x509", + "value": [ + "" + ] + } + ] + } + } + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json new file mode 100644 index 000000000000..3c29dd72608e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 2, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherWestUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherEastUSDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Delete.json new file mode 100644 index 000000000000..06757ae1ecbb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Delete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2022-01-03", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2022-01-03" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2022-01-03", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2022-01-03" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2022-01-03", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/westus2/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2022-01-03" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get.json new file mode 100644 index 000000000000..4c079af7c8b9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get_WithReplicationStatus.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get_WithReplicationStatus.json new file mode 100644 index 000000000000..3b5afaf96738 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get_WithReplicationStatus.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "$expand": "ReplicationStatus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "replicationStatus": { + "aggregatedState": "Completed", + "summary": [ + { + "region": "West US", + "state": "Completed", + "details": "", + "progress": 100 + }, + { + "region": "East US", + "state": "Completed", + "details": "", + "progress": 100 + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get_WithSnapshotsAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get_WithSnapshotsAsSource.json new file mode 100644 index 000000000000..d01494e741d4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get_WithSnapshotsAsSource.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{snapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{diskSnapshotName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get_WithVhdAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get_WithVhdAsSource.json new file mode 100644 index 000000000000..89c98c53469c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Get_WithVhdAsSource.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "storageAccountId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + }, + "lun": 1, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_ListByGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_ListByGalleryImage.json new file mode 100644 index 000000000000..2988899f26fc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_ListByGalleryImage.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "safetyProfile": { + "allowDeletionOfReplicatedLocations": false, + "reportedForPolicyViolation": true, + "policyViolations": [ + { + "category": "ImageFlaggedUnsafe", + "details": "This is the policy violation details." + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName/versions?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/images/myGalleryImageName/versions/myGalleryImageVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Update.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Update.json new file mode 100644 index 000000000000..7d16ee5d1192 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Update.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1 + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Update_WithoutSourceId.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Update_WithoutSourceId.json new file mode 100644 index 000000000000..c203fe064b8e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImageVersion_Update_WithoutSourceId.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1 + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ] + }, + "storageProfile": {} + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + }, + "excludeFromLatest": false + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS", + "excludeFromLatest": false + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Create.json new file mode 100644 index 000000000000..89cacb29cd43 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Create.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImage": { + "location": "West US", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Delete.json new file mode 100644 index 000000000000..278ca867b942 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Delete.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-10-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-10-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-10-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-10-01" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2021-10-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/CentralIndia/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2021-10-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Get.json new file mode 100644 index 000000000000..ec7fa9c28116 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Compute/galleries/myGallery/Images/myGalleryImageName", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_ListByGallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_ListByGallery.json new file mode 100644 index 000000000000..16e456bac91a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_ListByGallery.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryImageName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/images/myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Update.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Update.json new file mode 100644 index 000000000000..eb37c1cc8432 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/GalleryImage_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImage": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_AddToSharingProfile.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_AddToSharingProfile.json new file mode 100644 index 000000000000..3c813f29e914 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_AddToSharingProfile.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "sharingUpdate": { + "operationType": "Add", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "operationType": "Add", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/share?api-version=2022-08-03" + }, + "body": { + "operationType": "Add", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Create.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Create.json new file mode 100644 index 000000000000..cc40fe890e3e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Create.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description." + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json new file mode 100644 index 000000000000..730c4e568c96 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description.", + "softDeletePolicy": { + "isSoftDeleteEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "softDeletePolicy": { + "isSoftDeleteEnabled": true + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating", + "softDeletePolicy": { + "isSoftDeleteEnabled": true + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "softDeletePolicy": { + "isSoftDeleteEnabled": true + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Create_WithSharingProfile.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Create_WithSharingProfile.json new file mode 100644 index 000000000000..0c4db0ce760f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Create_WithSharingProfile.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description.", + "sharingProfile": { + "permissions": "Groups" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "sharingProfile": { + "permissions": "Groups" + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating", + "sharingProfile": { + "permissions": "Groups" + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "sharingProfile": { + "permissions": "Groups" + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Delete.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Delete.json new file mode 100644 index 000000000000..ed79941b1fe1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Delete.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2018-06-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2018-06-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2018-06-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2018-06-01" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?api-version=2018-06-01", + "Location": "https://management.azure.com/subscriptions/000000-8de3-42e7-b00e-8970003527749a/providers/Microsoft.Compute/locations/eastus/capsOperations/0012b61c-2d36-40bc-b7ed-1f0e48757277?monitor=true&api-version=2018-06-01" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_EnableCommunityGallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_EnableCommunityGallery.json new file mode 100644 index 000000000000..c930ab439054 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_EnableCommunityGallery.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "sharingUpdate": { + "operationType": "EnableCommunity" + } + }, + "responses": { + "200": { + "body": { + "operationType": "EnableCommunity" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/share?api-version=2022-08-03" + }, + "body": { + "operationType": "EnableCommunity" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Get.json new file mode 100644 index 000000000000..fcb44861b35d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Get_WithExpandSharingProfileGroups.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Get_WithExpandSharingProfileGroups.json new file mode 100644 index 000000000000..39c12c68bef7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Get_WithExpandSharingProfileGroups.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "$expand": "SharingProfile/Groups" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "sharingProfile": { + "permissions": "Groups", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Get_WithSelectPermissions.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Get_WithSelectPermissions.json new file mode 100644 index 000000000000..388d9ccaf255 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Get_WithSelectPermissions.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "$select": "Permissions" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName", + "properties": { + "sharingProfile": { + "permissions": "Groups", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_ListByResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_ListByResourceGroup.json new file mode 100644 index 000000000000..74f2eb1b157b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_ListByResourceGroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_ListBySubscription.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_ListBySubscription.json new file mode 100644 index 000000000000..7143e4818ff9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_ListBySubscription.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2022-08-03" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_ResetSharingProfile.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_ResetSharingProfile.json new file mode 100644 index 000000000000..9f392cd93d6d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_ResetSharingProfile.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "sharingUpdate": { + "operationType": "Reset" + } + }, + "responses": { + "200": { + "body": { + "operationType": "Reset" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/share?api-version=2022-08-03" + }, + "body": { + "operationType": "Reset" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Update.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Update.json new file mode 100644 index 000000000000..1e1f835cb4c3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/galleryExamples/Gallery_Update.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2022-08-03", + "galleryName": "myGalleryName", + "gallery": { + "properties": { + "description": "This is the gallery description." + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json new file mode 100644 index 000000000000..09bf1e7dc37f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03", + "galleryUniqueName": "galleryUniqueName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "myGalleryImageVersionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishedDate": "2018-03-20T09:12:28Z", + "endOfLifeDate": "2022-03-20T09:12:28Z", + "excludeFromLatest": false, + "storageProfile": { + "osDiskImage": { + "diskSizeGB": 29, + "hostCaching": "None" + } + }, + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + }, + "location": "myLocation", + "name": "myGalleryImageVersionName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName/Versions/myGalleryImageVersionName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImageVersions_List.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImageVersions_List.json new file mode 100644 index 000000000000..326efc04af34 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImageVersions_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03", + "galleryUniqueName": "galleryUniqueName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "publishedDate": "2018-03-20T09:12:28Z", + "endOfLifeDate": "2022-03-20T09:12:28Z", + "excludeFromLatest": false, + "storageProfile": { + "osDiskImage": { + "diskSizeGB": 29, + "hostCaching": "None" + } + }, + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + }, + "location": "myLocation", + "name": "myGalleryImageVersionName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName/Versions/myGalleryImageVersionName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscription-Id}/providers/Microsoft.Compute/sharedGalleries/galleryUniqueName/images/myGalleryImageName/versions?$skiptoken={token}/Subscriptions/{subscription-Id}/galleries/galleryUniqueName/images/myGalleryImageName/versions/myGalleryImageVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json new file mode 100644 index 000000000000..651948c2713b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImage_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03", + "galleryUniqueName": "galleryUniqueName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "eula": "https://www.microsoft.com/en-us/", + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + }, + "location": "myLocation", + "name": "myGalleryImageName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImages_List.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImages_List.json new file mode 100644 index 000000000000..d9ac8293278a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGalleryImages_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03", + "galleryUniqueName": "galleryUniqueName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + }, + "location": "myLocation", + "name": "myGalleryImageName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscription-Id}/providers/Microsoft.Compute/sharedGalleries/galleryUniqueName/images?$skiptoken={token}/Subscriptions/{subscription-Id}/galleries/galleryUniqueName/images/myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGallery_Get.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGallery_Get.json new file mode 100644 index 000000000000..5db761e6eeb0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGallery_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03", + "galleryUniqueName": "galleryUniqueName" + }, + "responses": { + "200": { + "body": { + "location": "myLocation", + "name": "myGalleryName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName" + }, + "properties": { + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGallery_List.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGallery_List.json new file mode 100644 index 000000000000..b272ccfab35b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/examples/sharedGalleryExamples/SharedGallery_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2022-08-03" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "myLocation", + "name": "galleryUniqueName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName" + }, + "properties": { + "artifactTags": { + "ShareTag-Official1PGallery": "Official1PGallery" + } + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/sharedGalleries?$skiptoken={token}/Subscriptions/{subscriptionId}/galleries/galleryUniqueName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json new file mode 100644 index 000000000000..7b42b2865e51 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json @@ -0,0 +1,3282 @@ +{ + "swagger": "2.0", + "info": { + "title": "SharedImageGalleryServiceClient", + "description": "Shared Image Gallery Service Client.", + "version": "2022-08-03" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}": { + "put": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_CreateOrUpdate", + "description": "Create or update a Shared Image Gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "gallery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Gallery" + }, + "description": "Parameters supplied to the create or update Shared Image Gallery operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery.": { + "$ref": "./examples/galleryExamples/Gallery_Create.json" + }, + "Create or update a simple gallery with sharing profile.": { + "$ref": "./examples/galleryExamples/Gallery_Create_WithSharingProfile.json" + }, + "Create or update a simple gallery with soft deletion enabled.": { + "$ref": "./examples/galleryExamples/Gallery_Create_SoftDeletionEnabled.json" + }, + "Create a community gallery.": { + "$ref": "./examples/galleryExamples/CommunityGallery_Create.json" + } + } + }, + "patch": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Update", + "description": "Update a Shared Image Gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "gallery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryUpdate" + }, + "description": "Parameters supplied to the update Shared Image Gallery operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery.": { + "$ref": "./examples/galleryExamples/Gallery_Update.json" + } + } + }, + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Get", + "description": "Retrieves information about a Shared Image Gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The select expression to apply on the operation.", + "enum": [ + "Permissions" + ], + "x-ms-enum": { + "name": "SelectPermissions", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/GalleryODataExpandQueryParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery.": { + "$ref": "./examples/galleryExamples/Gallery_Get.json" + }, + "Get a gallery with select permissions.": { + "$ref": "./examples/galleryExamples/Gallery_Get_WithSelectPermissions.json" + }, + "Get a gallery with expand sharingProfile groups.": { + "$ref": "./examples/galleryExamples/Gallery_Get_WithExpandSharingProfileGroups.json" + }, + "Get a community gallery.": { + "$ref": "./examples/galleryExamples/CommunityGallery_Get.json" + } + } + }, + "delete": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Delete", + "description": "Delete a Shared Image Gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery to be deleted." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery.": { + "$ref": "./examples/galleryExamples/Gallery_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}": { + "put": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_CreateOrUpdate", + "description": "Create or update a gallery image definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition is to be created." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImage", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImage" + }, + "description": "Parameters supplied to the create or update gallery image operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery image.": { + "$ref": "./examples/galleryExamples/GalleryImage_Create.json" + } + } + }, + "patch": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Update", + "description": "Update a gallery image definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition is to be updated." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImage", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageUpdate" + }, + "description": "Parameters supplied to the update gallery image operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery image.": { + "$ref": "./examples/galleryExamples/GalleryImage_Update.json" + } + } + }, + "get": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Get", + "description": "Retrieves information about a gallery image definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery from which the Image Definitions are to be retrieved." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be retrieved." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery image.": { + "$ref": "./examples/galleryExamples/GalleryImage_Get.json" + } + } + }, + "delete": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Delete", + "description": "Delete a gallery image.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition is to be deleted." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be deleted." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery image.": { + "$ref": "./examples/galleryExamples/GalleryImage_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}": { + "put": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_CreateOrUpdate", + "description": "Create or update a gallery image version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version is to be created." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImageVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + }, + "description": "Parameters supplied to the create or update gallery image version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple Gallery Image Version using managed image as source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create.json" + }, + "Create or update a simple Gallery Image Version using snapshots as a source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json" + }, + "Create or update a simple Gallery Image Version using VM as source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithVmAsSource.json" + }, + "Create or update a simple Gallery Image Version using shared image as source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithImageVersionAsSource.json" + }, + "Create or update a simple Gallery Image Version using community gallery image as source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithCommunityImageVersionAsSource.json" + }, + "Create or update a simple Gallery Image Version using mix of disks and snapshots as a source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithSnapshotsAsSource.json" + }, + "Create or update a simple Gallery Image Version using vhd as a source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithVHD.json" + }, + "Create or update a simple Gallery Image Version using shallow replication mode.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithShallowReplicationMode.json" + }, + "Create or update a simple gallery image version with target extended locations specified.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithTargetExtendedLocations.json" + }, + "Create or update a simple Gallery Image Version using vhd as a source with custom UEFI keys.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Create_WithVHD_UefiSettings.json" + } + } + }, + "patch": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Update", + "description": "Update a gallery image version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version is to be updated." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImageVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageVersionUpdate" + }, + "description": "Parameters supplied to the update gallery image version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple Gallery Image Version (Managed Image as source).": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Update.json" + }, + "Update a simple Gallery Image Version without source id.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Update_WithoutSourceId.json" + } + } + }, + "get": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Get", + "description": "Retrieves information about a gallery image version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version resides." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be retrieved." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "ReplicationStatus", + "UefiSettings" + ], + "x-ms-enum": { + "name": "ReplicationStatusTypes", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery image version.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Get.json" + }, + "Get a gallery image version with replication status.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Get_WithReplicationStatus.json" + }, + "Get a gallery image version with snapshots as a source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Get_WithSnapshotsAsSource.json" + }, + "Get a gallery image version with vhd as a source.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Get_WithVhdAsSource.json" + } + } + }, + "delete": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Delete", + "description": "Delete a gallery image version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version resides." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be deleted." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery image version.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}": { + "put": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_CreateOrUpdate", + "description": "Create or update a gallery Application Definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition is to be created." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplication", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplication" + }, + "description": "Parameters supplied to the create or update gallery Application operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery Application.": { + "$ref": "./examples/galleryExamples/GalleryApplication_Create.json" + } + } + }, + "patch": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_Update", + "description": "Update a gallery Application Definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition is to be updated." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplication", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationUpdate" + }, + "description": "Parameters supplied to the update gallery Application operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery Application.": { + "$ref": "./examples/galleryExamples/GalleryApplication_Update.json" + } + } + }, + "get": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_Get", + "description": "Retrieves information about a gallery Application Definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery from which the Application Definitions are to be retrieved." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be retrieved." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery Application.": { + "$ref": "./examples/galleryExamples/GalleryApplication_Get.json" + } + } + }, + "delete": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_Delete", + "description": "Delete a gallery Application.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition is to be deleted." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be deleted." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery Application.": { + "$ref": "./examples/galleryExamples/GalleryApplication_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}": { + "put": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_CreateOrUpdate", + "description": "Create or update a gallery Application Version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version is to be created." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplicationVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + }, + "description": "Parameters supplied to the create or update gallery Application Version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery Application Version.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_Create.json" + } + } + }, + "patch": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_Update", + "description": "Update a gallery Application Version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version is to be updated." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplicationVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationVersionUpdate" + }, + "description": "Parameters supplied to the update gallery Application Version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery Application Version.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_Update.json" + } + } + }, + "get": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_Get", + "description": "Retrieves information about a gallery Application Version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version resides." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be retrieved." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "ReplicationStatus", + "UefiSettings" + ], + "x-ms-enum": { + "name": "ReplicationStatusTypes", + "modelAsString": true + } + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery Application Version.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_Get.json" + }, + "Get a gallery Application Version with replication status.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_Get_WithReplicationStatus.json" + } + } + }, + "delete": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_Delete", + "description": "Delete a gallery Application Version.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version resides." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be deleted." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a gallery Application Version.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_ListByResourceGroup", + "description": "List galleries under a resource group.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List galleries in a resource group.": { + "$ref": "./examples/galleryExamples/Gallery_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_List", + "description": "List galleries under a subscription.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List galleries in a subscription.": { + "$ref": "./examples/galleryExamples/Gallery_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images": { + "get": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_ListByGallery", + "description": "List gallery image definitions in a gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery from which Image Definitions are to be listed." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery images in a gallery.": { + "$ref": "./examples/galleryExamples/GalleryImage_ListByGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions": { + "get": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_ListByGalleryImage", + "description": "List gallery image versions in a gallery image definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery Image Definition from which the Image Versions are to be listed." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery image versions in a gallery image definition.": { + "$ref": "./examples/galleryExamples/GalleryImageVersion_ListByGalleryImage.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications": { + "get": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_ListByGallery", + "description": "List gallery Application Definitions in a gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery from which Application Definitions are to be listed." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery Applications in a gallery.": { + "$ref": "./examples/galleryExamples/GalleryApplication_ListByGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions": { + "get": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_ListByGalleryApplication", + "description": "List gallery Application Versions in a gallery Application Definition.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery Application Definition from which the Application Versions are to be listed." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery Application Versions in a gallery Application Definition.": { + "$ref": "./examples/galleryExamples/GalleryApplicationVersion_ListByGalleryApplication.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/share": { + "post": { + "tags": [ + "GallerySharingUpdate" + ], + "operationId": "GallerySharingProfile_Update", + "description": "Update sharing profile of a gallery.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "sharingUpdate", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SharingUpdate" + }, + "description": "Parameters supplied to the update gallery sharing profile." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharingUpdate" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SharingUpdate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add sharing id to the sharing profile of a gallery.": { + "$ref": "./examples/galleryExamples/Gallery_AddToSharingProfile.json" + }, + "share a gallery to community.": { + "$ref": "./examples/galleryExamples/Gallery_EnableCommunityGallery.json" + }, + "reset sharing profile of a gallery.": { + "$ref": "./examples/galleryExamples/Gallery_ResetSharingProfile.json" + } + } + } + } + }, + "definitions": { + "Gallery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the Shared Image Gallery that you want to create or update." + }, + "GalleryUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the Shared Image Gallery that you want to update." + }, + "GalleryProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this Shared Image Gallery resource. This property is updatable." + }, + "identifier": { + "$ref": "#/definitions/GalleryIdentifier" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/GalleryProvisioningState" + }, + "sharingProfile": { + "$ref": "#/definitions/SharingProfile" + }, + "softDeletePolicy": { + "$ref": "#/definitions/SoftDeletePolicy" + }, + "sharingStatus": { + "readOnly": true, + "$ref": "#/definitions/SharingStatus" + } + }, + "description": "Describes the properties of a Shared Image Gallery." + }, + "GalleryIdentifier": { + "properties": { + "uniqueName": { + "readOnly": true, + "type": "string", + "description": "The unique name of the Shared Image Gallery. This name is generated automatically by Azure." + } + }, + "description": "Describes the gallery unique name." + }, + "SharingProfile": { + "description": "Profile for gallery sharing to subscription or tenant", + "properties": { + "permissions": { + "type": "string", + "description": "This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.**", + "enum": [ + "Private", + "Groups", + "Community" + ], + "x-ms-enum": { + "name": "GallerySharingPermissionTypes", + "modelAsString": true + } + }, + "groups": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SharingProfileGroup" + }, + "x-ms-identifiers": [], + "description": "A list of sharing profile groups." + }, + "communityGalleryInfo": { + "$ref": "#/definitions/CommunityGalleryInfo", + "description": "Information of community gallery if current gallery is shared to community." + } + } + }, + "SharingProfileGroup": { + "description": "Group of the gallery sharing profile", + "properties": { + "type": { + "type": "string", + "description": "This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.**", + "enum": [ + "Subscriptions", + "AADTenants" + ], + "x-ms-enum": { + "name": "SharingProfileGroupTypes", + "modelAsString": true + } + }, + "ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of subscription/tenant ids the gallery is aimed to be shared to." + } + } + }, + "CommunityGalleryInfo": { + "type": "object", + "description": "Information of community gallery if current gallery is shared to community", + "properties": { + "publisherUri": { + "type": "string", + "description": "The link to the publisher website. Visible to all users." + }, + "publisherContact": { + "type": "string", + "description": "Community gallery publisher support email. The email address of the publisher. Visible to all users." + }, + "eula": { + "type": "string", + "description": "End-user license agreement for community gallery image." + }, + "publicNamePrefix": { + "type": "string", + "description": "The prefix of the gallery name that will be displayed publicly. Visible to all users." + }, + "communityGalleryEnabled": { + "readOnly": true, + "type": "boolean", + "description": "Contains info about whether community gallery sharing is enabled." + }, + "publicNames": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Community gallery public name list." + } + } + }, + "SoftDeletePolicy": { + "type": "object", + "properties": { + "isSoftDeleteEnabled": { + "type": "boolean", + "description": "Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time." + } + }, + "description": "Contains information about the soft deletion policy of the gallery." + }, + "SharingStatus": { + "type": "object", + "properties": { + "aggregatedState": { + "type": "string", + "$ref": "#/definitions/SharingState", + "description": "Aggregated sharing state of current gallery." + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/definitions/RegionalSharingStatus" + }, + "x-ms-identifiers": [ + "region" + ], + "description": "Summary of all regional sharing status." + } + }, + "description": "Sharing status of current gallery." + }, + "SharingState": { + "readOnly": true, + "type": "string", + "title": "The sharing state of the gallery.", + "description": "The sharing state of the gallery, which only appears in the response.", + "enum": [ + "Succeeded", + "InProgress", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "SharingState", + "modelAsString": true + } + }, + "RegionalSharingStatus": { + "type": "object", + "description": "Gallery regional sharing status", + "properties": { + "region": { + "type": "string", + "description": "Region name" + }, + "state": { + "type": "string", + "$ref": "#/definitions/SharingState", + "description": "Gallery sharing state in current region" + }, + "details": { + "type": "string", + "description": "Details of gallery regional sharing failure." + } + } + }, + "GalleryApplication": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery Application Definition that you want to create or update." + }, + "GalleryApplicationUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery Application Definition that you want to update." + }, + "GalleryApplicationProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery Application Definition resource. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery Application Definition." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "supportedOSType": { + "type": "string", + "description": "This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "customActions": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryApplicationCustomAction" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application." + } + }, + "required": [ + "supportedOSType" + ], + "description": "Describes the properties of a gallery Application Definition." + }, + "GalleryApplicationVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationVersionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery Application Version that you want to create or update." + }, + "GalleryApplicationVersionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery Application Version that you want to update." + }, + "GalleryApplicationVersionProperties": { + "properties": { + "publishingProfile": { + "$ref": "#/definitions/GalleryApplicationVersionPublishingProfile" + }, + "safetyProfile": { + "$ref": "#/definitions/GalleryApplicationVersionSafetyProfile" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/GalleryProvisioningState" + }, + "replicationStatus": { + "readOnly": true, + "$ref": "#/definitions/ReplicationStatus" + } + }, + "required": [ + "publishingProfile" + ], + "description": "Describes the properties of a gallery image version." + }, + "GalleryApplicationVersionPublishingProfile": { + "properties": { + "source": { + "$ref": "#/definitions/UserArtifactSource" + }, + "manageActions": { + "$ref": "#/definitions/UserArtifactManage" + }, + "settings": { + "$ref": "#/definitions/UserArtifactSettings" + }, + "advancedSettings": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only." + }, + "enableHealthCheck": { + "type": "boolean", + "description": "Optional. Whether or not this application reports health." + }, + "customActions": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryApplicationCustomAction" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of custom actions that can be performed with this Gallery Application Version." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactPublishingProfileBase" + } + ], + "required": [ + "source" + ], + "description": "The publishing profile of a gallery image version." + }, + "GalleryApplicationVersionSafetyProfile": { + "type": "object", + "properties": {}, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactSafetyProfileBase" + } + ], + "description": "The safety profile of the Gallery Application Version." + }, + "GalleryApplicationCustomAction": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the custom action. Must be unique within the Gallery Application Version." + }, + "script": { + "type": "string", + "description": "The script to run when executing this custom action." + }, + "description": { + "type": "string", + "description": "Description to help the users understand what this custom action does." + }, + "parameters": { + "type": "array", + "description": "The parameters that this custom action uses", + "items": { + "$ref": "#/definitions/GalleryApplicationCustomActionParameter" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "name", + "script" + ], + "description": "A custom action that can be performed with a Gallery Application Version." + }, + "GalleryApplicationCustomActionParameter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the custom action. Must be unique within the Gallery Application Version." + }, + "required": { + "type": "boolean", + "description": "Indicates whether this parameter must be passed when running the custom action." + }, + "type": { + "type": "string", + "description": "Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob", + "enum": [ + "String", + "ConfigurationDataBlob", + "LogOutputBlob" + ], + "x-ms-enum": { + "name": "GalleryApplicationCustomActionParameterType", + "modelAsString": false + } + }, + "defaultValue": { + "type": "string", + "description": "The default value of the parameter. Only applies to string types" + }, + "description": { + "type": "string", + "description": "A description to help users understand what this parameter means" + } + }, + "required": [ + "name" + ], + "description": "The definition of a parameter that can be passed to a custom action of a Gallery Application Version." + }, + "UserArtifactSource": { + "properties": { + "mediaLink": { + "type": "string", + "description": "Required. The mediaLink of the artifact, must be a readable storage page blob." + }, + "defaultConfigurationLink": { + "type": "string", + "description": "Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob." + } + }, + "required": [ + "mediaLink" + ], + "description": "The source image from which the Image Version is going to be created." + }, + "UserArtifactManage": { + "properties": { + "install": { + "type": "string", + "description": "Required. The path and arguments to install the gallery application. This is limited to 4096 characters." + }, + "remove": { + "type": "string", + "description": "Required. The path and arguments to remove the gallery application. This is limited to 4096 characters." + }, + "update": { + "type": "string", + "description": "Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters." + } + }, + "required": [ + "install", + "remove" + ] + }, + "UserArtifactSettings": { + "type": "object", + "properties": { + "packageFileName": { + "type": "string", + "description": "Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name." + }, + "configFileName": { + "type": "string", + "description": "Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with \"_config\"." + } + }, + "description": "Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set." + }, + "GalleryImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery image definition that you want to create or update." + }, + "GalleryImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery image definition that you want to update." + }, + "GalleryImageProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery image definition resource. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery image definition." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "identifier": { + "$ref": "./galleryRPCommon.json#/definitions/GalleryImageIdentifier" + }, + "recommended": { + "$ref": "./galleryRPCommon.json#/definitions/RecommendedMachineConfiguration" + }, + "disallowed": { + "$ref": "./galleryRPCommon.json#/definitions/Disallowed" + }, + "purchasePlan": { + "$ref": "./galleryRPCommon.json#/definitions/ImagePurchasePlan" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/GalleryProvisioningState" + }, + "features": { + "type": "array", + "items": { + "$ref": "./galleryRPCommon.json#/definitions/GalleryImageFeature" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of gallery image features." + }, + "architecture": { + "$ref": "./galleryRPCommon.json#/definitions/Architecture" + } + }, + "required": [ + "osType", + "osState", + "identifier" + ], + "description": "Describes the properties of a gallery image definition." + }, + "GalleryImageVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common-types/v1/common.json#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "GalleryImageVersionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery image version that you want to update." + }, + "GalleryImageVersionProperties": { + "properties": { + "publishingProfile": { + "$ref": "#/definitions/GalleryImageVersionPublishingProfile" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/GalleryProvisioningState" + }, + "storageProfile": { + "$ref": "#/definitions/GalleryImageVersionStorageProfile" + }, + "safetyProfile": { + "$ref": "#/definitions/GalleryImageVersionSafetyProfile" + }, + "replicationStatus": { + "readOnly": true, + "$ref": "#/definitions/ReplicationStatus" + }, + "securityProfile": { + "$ref": "#/definitions/ImageVersionSecurityProfile" + } + }, + "required": [ + "storageProfile" + ], + "description": "Describes the properties of a gallery image version." + }, + "GalleryArtifactPublishingProfileBase": { + "properties": { + "targetRegions": { + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." + }, + "replicaCount": { + "type": "integer", + "format": "int32", + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." + }, + "excludeFromLatest": { + "type": "boolean", + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "publishedDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The timestamp for when the gallery image version is published." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable." + }, + "storageAccountType": { + "type": "string", + "description": "Specifies the storage account type to be used to store the image. This property is not updatable.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + }, + "replicationMode": { + "type": "string", + "description": "Optional parameter which specifies the mode to be used for replication. This property is not updatable.", + "enum": [ + "Full", + "Shallow" + ], + "x-ms-enum": { + "name": "ReplicationMode", + "modelAsString": true + } + }, + "targetExtendedLocations": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryTargetExtendedLocation" + }, + "x-ms-identifiers": [ + "name", + "extendedLocation/name" + ], + "description": "The target extended locations where the Image Version is going to be replicated to. This property is updatable." + } + }, + "description": "Describes the basic gallery artifact publishing profile." + }, + "TargetRegion": { + "properties": { + "name": { + "type": "string", + "description": "The name of the region." + }, + "regionalReplicaCount": { + "type": "integer", + "format": "int32", + "description": "The number of replicas of the Image Version to be created per region. This property is updatable." + }, + "storageAccountType": { + "type": "string", + "description": "Specifies the storage account type to be used to store the image. This property is not updatable.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + }, + "encryption": { + "$ref": "#/definitions/EncryptionImages" + }, + "excludeFromLatest": { + "type": "boolean", + "description": "Contains the flag setting to hide an image when users specify version='latest'" + } + }, + "required": [ + "name" + ], + "description": "Describes the target region information." + }, + "GalleryTargetExtendedLocation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the region." + }, + "extendedLocation": { + "$ref": "#/definitions/GalleryExtendedLocation" + }, + "extendedLocationReplicaCount": { + "type": "integer", + "format": "int32", + "description": "The number of replicas of the Image Version to be created per extended location. This property is updatable." + }, + "storageAccountType": { + "type": "string", + "description": "Specifies the storage account type to be used to store the image. This property is not updatable.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "StandardSSD_LRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "EdgeZoneStorageAccountType", + "modelAsString": true + } + }, + "encryption": { + "$ref": "#/definitions/EncryptionImages" + } + } + }, + "GalleryExtendedLocation": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "$ref": "#/definitions/GalleryExtendedLocationType" + } + }, + "description": "The name of the extended location." + }, + "GalleryExtendedLocationType": { + "type": "string", + "enum": [ + "EdgeZone", + "Unknown" + ], + "x-ms-enum": { + "name": "GalleryExtendedLocationType", + "modelAsString": true + }, + "description": "It is type of the extended location." + }, + "EncryptionImages": { + "properties": { + "osDiskImage": { + "$ref": "#/definitions/OSDiskImageEncryption" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImageEncryption" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "A list of encryption specifications for data disk images." + } + }, + "description": "Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact." + }, + "OSDiskImageEncryption": { + "type": "object", + "properties": { + "securityProfile": { + "type": "object", + "$ref": "#/definitions/OSDiskImageSecurityProfile", + "description": "This property specifies the security profile of an OS disk image." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DiskImageEncryption" + } + ], + "description": "Contains encryption settings for an OS disk image." + }, + "OSDiskImageSecurityProfile": { + "type": "object", + "properties": { + "confidentialVMEncryptionType": { + "type": "string", + "description": "confidential VM encryption types", + "enum": [ + "EncryptedVMGuestStateOnlyWithPmk", + "EncryptedWithPmk", + "EncryptedWithCmk", + "NonPersistedTPM" + ], + "x-ms-enum": { + "name": "ConfidentialVMEncryptionType", + "modelAsString": true + } + }, + "secureVMDiskEncryptionSetId": { + "type": "string", + "description": "secure VM disk encryption set id" + } + }, + "description": "Contains security profile for an OS disk image." + }, + "DataDiskImageEncryption": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DiskImageEncryption" + } + ], + "required": [ + "lun" + ], + "description": "Contains encryption settings for a data disk image." + }, + "DiskImageEncryption": { + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "A relative URI containing the resource ID of the disk encryption set." + } + }, + "description": "This is the disk image encryption base class." + }, + "GalleryArtifactSource": { + "properties": { + "managedImage": { + "$ref": "#/definitions/ManagedArtifact" + } + }, + "required": [ + "managedImage" + ], + "description": "The source image from which the Image Version is going to be created." + }, + "ManagedArtifact": { + "properties": { + "id": { + "type": "string", + "description": "The managed artifact id." + } + }, + "required": [ + "id" + ], + "description": "The managed artifact." + }, + "GalleryImageVersionPublishingProfile": { + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactPublishingProfileBase" + } + ], + "description": "The publishing profile of a gallery image Version." + }, + "GalleryImageVersionStorageProfile": { + "properties": { + "source": { + "$ref": "#/definitions/GalleryArtifactVersionFullSource" + }, + "osDiskImage": { + "$ref": "#/definitions/GalleryOSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryDataDiskImage" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "A list of data disk images." + } + }, + "description": "This is the storage profile of a Gallery Image Version." + }, + "GalleryArtifactVersionFullSource": { + "type": "object", + "properties": { + "communityGalleryImageId": { + "type": "string", + "description": "The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactVersionSource" + } + ], + "description": "The source of the gallery artifact version." + }, + "GalleryArtifactVersionSource": { + "properties": { + "id": { + "type": "string", + "description": "The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource." + } + }, + "description": "The gallery artifact version source." + }, + "GalleryOSDiskImage": { + "allOf": [ + { + "$ref": "#/definitions/GalleryDiskImage" + } + ], + "description": "This is the OS disk image." + }, + "GalleryDataDiskImage": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryDiskImage" + } + ], + "required": [ + "lun" + ], + "description": "This is the data disk image." + }, + "GalleryDiskImage": { + "properties": { + "sizeInGB": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "This property indicates the size of the VHD to be created." + }, + "hostCaching": { + "type": "string", + "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "HostCaching", + "modelAsString": false + } + }, + "source": { + "$ref": "#/definitions/GalleryDiskImageSource" + } + }, + "description": "This is the disk image base class." + }, + "GalleryDiskImageSource": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "The uri of the gallery artifact version source. Currently used to specify vhd/blob source." + }, + "storageAccountId": { + "type": "string", + "description": "The Storage Account Id that contains the vhd blob being used as a source for this artifact version." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactVersionSource" + } + ], + "description": "The source for the disk image." + }, + "GalleryArtifactSafetyProfileBase": { + "type": "object", + "properties": { + "allowDeletionOfReplicatedLocations": { + "type": "boolean", + "description": "Indicates whether or not removing this Gallery Image Version from replicated regions is allowed." + } + }, + "description": "This is the safety profile of the Gallery Artifact Version." + }, + "GalleryImageVersionSafetyProfile": { + "type": "object", + "properties": { + "reportedForPolicyViolation": { + "type": "boolean", + "description": "Indicates whether this image has been reported as violating Microsoft's policies.", + "readOnly": true + }, + "policyViolations": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyViolation" + }, + "x-ms-identifiers": [], + "description": "A list of Policy Violations that have been reported for this Gallery Image Version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactSafetyProfileBase" + } + ], + "description": "This is the safety profile of the Gallery Image Version." + }, + "PolicyViolation": { + "type": "object", + "properties": { + "category": { + "type": "string", + "description": "Describes the nature of the policy violation.", + "enum": [ + "Other", + "ImageFlaggedUnsafe", + "CopyrightValidation", + "IpTheft" + ], + "x-ms-enum": { + "name": "PolicyViolationCategory", + "modelAsString": true + } + }, + "details": { + "type": "string", + "description": "Describes specific details about why this policy violation was reported." + } + }, + "description": "A policy violation reported against a gallery artifact." + }, + "ImageVersionSecurityProfile": { + "type": "object", + "description": "The security profile of a gallery image version", + "properties": { + "uefiSettings": { + "$ref": "#/definitions/GalleryImageVersionUefiSettings" + } + } + }, + "ReplicationStatus": { + "properties": { + "aggregatedState": { + "readOnly": true, + "type": "string", + "description": "This is the aggregated replication status based on all the regional replication status flags.", + "enum": [ + "Unknown", + "InProgress", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "AggregatedReplicationState", + "modelAsString": true + } + }, + "summary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RegionalReplicationStatus" + }, + "x-ms-identifiers": [ + "region" + ], + "description": "This is a summary of replication status for each region." + } + }, + "description": "This is the replication status of the gallery image version." + }, + "RegionalReplicationStatus": { + "properties": { + "region": { + "readOnly": true, + "type": "string", + "description": "The region to which the gallery image version is being replicated to." + }, + "state": { + "readOnly": true, + "type": "string", + "description": "This is the regional replication state.", + "enum": [ + "Unknown", + "Replicating", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "ReplicationState", + "modelAsString": true + } + }, + "details": { + "readOnly": true, + "type": "string", + "description": "The details of the replication status." + }, + "progress": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "It indicates progress of the replication job." + } + }, + "description": "This is the regional replication status." + }, + "GalleryList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Gallery" + }, + "description": "A list of galleries." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries." + } + }, + "required": [ + "value" + ], + "description": "The List Galleries operation response." + }, + "GalleryImageList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImage" + }, + "description": "A list of Shared Image Gallery images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Images operation response." + }, + "GalleryImageVersionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImageVersion" + }, + "description": "A list of gallery image versions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of gallery image versions. Call ListNext() with this to fetch the next page of gallery image versions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Image version operation response." + }, + "GalleryApplicationList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryApplication" + }, + "description": "A list of Gallery Applications." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Application Definitions in the Application Gallery. Call ListNext() with this to fetch the next page of gallery Application Definitions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Applications operation response." + }, + "GalleryApplicationVersionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryApplicationVersion" + }, + "description": "A list of gallery Application Versions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Application version operation response." + }, + "UpdateResourceDefinition": { + "description": "The Update Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true + }, + "SharingUpdate": { + "description": "Specifies information about the gallery sharing profile update.", + "properties": { + "operationType": { + "type": "string", + "description": "This property allows you to specify the operation type of gallery sharing update. Possible values are: **Add,** **Remove,** **Reset.**", + "enum": [ + "Add", + "Remove", + "Reset", + "EnableCommunity" + ], + "x-ms-enum": { + "name": "SharingUpdateOperationTypes", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/definitions/SharingProfileGroup" + }, + "x-ms-identifiers": [], + "description": "A list of sharing profile groups." + } + }, + "required": [ + "operationType" + ], + "x-ms-azure-resource": true + }, + "GalleryProvisioningState": { + "readOnly": true, + "type": "string", + "title": "The current state of the gallery or gallery artifact.", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ], + "x-ms-enum": { + "name": "GalleryProvisioningState", + "modelAsString": true + } + }, + "LatestGalleryImageVersion": { + "type": "object", + "readOnly": true, + "description": "The gallery image version with latest version in a particular region.", + "properties": { + "latestVersionName": { + "type": "string", + "description": "The name of the latest version in the region." + }, + "location": { + "type": "string", + "description": "region of the Gallery Image Version." + } + } + }, + "GalleryImageVersionUefiSettings": { + "type": "object", + "description": "Contains UEFI settings for the image version.", + "properties": { + "signatureTemplateNames": { + "type": "array", + "description": "The name of the template(s) that contains default UEFI key signatures that will be added to the image.", + "items": { + "$ref": "#/definitions/UefiSignatureTemplateName" + }, + "x-ms-identifiers": [] + }, + "additionalSignatures": { + "$ref": "#/definitions/UefiKeySignatures" + } + } + }, + "UefiSignatureTemplateName": { + "type": "string", + "description": "The name of the signature template that contains default UEFI keys.", + "enum": [ + "NoSignatureTemplate", + "MicrosoftUefiCertificateAuthorityTemplate", + "MicrosoftWindowsTemplate" + ], + "x-ms-enum": { + "name": "UefiSignatureTemplateName", + "modelAsString": true + } + }, + "UefiKeySignatures": { + "type": "object", + "description": "Additional UEFI key signatures that will be added to the image in addition to the signature templates", + "properties": { + "pk": { + "description": "The Platform Key of this image version.", + "$ref": "#/definitions/UefiKey" + }, + "kek": { + "type": "array", + "description": "The Key Encryption Keys of this image version.", + "items": { + "$ref": "#/definitions/UefiKey" + }, + "x-ms-identifiers": [] + }, + "db": { + "type": "array", + "description": "The database of UEFI keys for this image version.", + "items": { + "$ref": "#/definitions/UefiKey" + }, + "x-ms-identifiers": [] + }, + "dbx": { + "type": "array", + "description": "The database of revoked UEFI keys for this image version.", + "items": { + "$ref": "#/definitions/UefiKey" + }, + "x-ms-identifiers": [] + } + } + }, + "UefiKey": { + "type": "object", + "description": "A UEFI key signature.", + "properties": { + "type": { + "type": "string", + "description": "The type of key signature.", + "enum": [ + "sha256", + "x509" + ], + "x-ms-enum": { + "name": "UefiKeyType", + "modelAsString": true + } + }, + "value": { + "type": "array", + "description": "The value of the key signature.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the resource group." + }, + "GalleryODataExpandQueryParameter": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand query option to apply on the operation.", + "enum": [ + "SharingProfile/Groups" + ], + "x-ms-enum": { + "name": "GalleryExpandParams", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json new file mode 100644 index 000000000000..e50b347b1c13 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json @@ -0,0 +1,222 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2022-08-03" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "GalleryImageFeature": { + "properties": { + "name": { + "type": "string", + "description": "The name of the gallery image feature." + }, + "value": { + "type": "string", + "description": "The value of the gallery image feature." + } + }, + "description": "A feature for gallery image." + }, + "GalleryImageIdentifier": { + "properties": { + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "required": [ + "publisher", + "offer", + "sku" + ], + "description": "This is the gallery image definition identifier." + }, + "RecommendedMachineConfiguration": { + "properties": { + "vCPUs": { + "$ref": "#/definitions/ResourceRange" + }, + "memory": { + "$ref": "#/definitions/ResourceRange" + } + }, + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "ResourceRange": { + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum number of the resource." + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum number of the resource." + } + }, + "description": "Describes the resource range." + }, + "Disallowed": { + "properties": { + "diskTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of disk types." + } + }, + "description": "Describes the disallowed disk types." + }, + "ImagePurchasePlan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "The product ID." + } + }, + "description": "Describes the gallery image definition purchase plan. This is used by marketplace images." + }, + "SharedGalleryImageVersionStorageProfile": { + "type": "object", + "properties": { + "osDiskImage": { + "$ref": "#/definitions/SharedGalleryOSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGalleryDataDiskImage" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "A list of data disk images." + } + }, + "description": "This is the storage profile of a Gallery Image Version." + }, + "SharedGalleryOSDiskImage": { + "allOf": [ + { + "$ref": "#/definitions/SharedGalleryDiskImage" + } + ], + "description": "This is the OS disk image." + }, + "SharedGalleryDataDiskImage": { + "type": "object", + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SharedGalleryDiskImage" + } + ], + "required": [ + "lun" + ], + "description": "This is the data disk image." + }, + "SharedGalleryDiskImage": { + "type": "object", + "properties": { + "diskSizeGB": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "This property indicates the size of the VHD to be created." + }, + "hostCaching": { + "type": "string", + "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "SharedGalleryHostCaching", + "modelAsString": true + } + } + }, + "description": "This is the disk image base class." + }, + "Architecture": { + "type": "string", + "description": "The architecture of the image. Applicable to OS disks only.", + "enum": [ + "x64", + "Arm64" + ], + "x-ms-enum": { + "name": "Architecture", + "modelAsString": true + } + } + }, + "parameters": { + "LocationNameParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Resource location." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json new file mode 100644 index 000000000000..c979d5699af5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json @@ -0,0 +1,660 @@ +{ + "swagger": "2.0", + "info": { + "title": "SharedGalleryServiceClient", + "description": "Shared Gallery Service Client.", + "version": "2022-08-03" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries": { + "get": { + "tags": [ + "SharedGalleries" + ], + "operationId": "SharedGalleries_List", + "description": "List shared galleries by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "sharedTo", + "in": "query", + "required": false, + "type": "string", + "description": "The query parameter to decide what shared galleries to fetch when doing listing operations.", + "enum": [ + "tenant" + ], + "x-ms-enum": { + "name": "SharedToValues", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List shared galleries.": { + "$ref": "./examples/sharedGalleryExamples/SharedGallery_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images": { + "get": { + "tags": [ + "SharedGalleryImages" + ], + "operationId": "SharedGalleryImages_List", + "description": "List shared gallery images by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "sharedTo", + "in": "query", + "required": false, + "type": "string", + "description": "The query parameter to decide what shared galleries to fetch when doing listing operations.", + "enum": [ + "tenant" + ], + "x-ms-enum": { + "name": "SharedToValues", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List shared gallery images.": { + "$ref": "./examples/sharedGalleryExamples/SharedGalleryImages_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions": { + "get": { + "tags": [ + "SharedGalleryImageVersions" + ], + "operationId": "SharedGalleryImageVersions_List", + "description": "List shared gallery image versions by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Gallery Image Definition from which the Image Versions are to be listed." + }, + { + "name": "sharedTo", + "in": "query", + "required": false, + "type": "string", + "description": "The query parameter to decide what shared galleries to fetch when doing listing operations.", + "enum": [ + "tenant" + ], + "x-ms-enum": { + "name": "SharedToValues", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImageVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List shared gallery image versions.": { + "$ref": "./examples/sharedGalleryExamples/SharedGalleryImageVersions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}": { + "get": { + "tags": [ + "SharedGalleries" + ], + "operationId": "SharedGalleries_Get", + "description": "Get a shared gallery by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a shared gallery.": { + "$ref": "./examples/sharedGalleryExamples/SharedGallery_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}": { + "get": { + "tags": [ + "SharedGalleryImages" + ], + "operationId": "SharedGalleryImages_Get", + "description": "Get a shared gallery image by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Gallery Image Definition from which the Image Versions are to be listed." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a shared gallery image.": { + "$ref": "./examples/sharedGalleryExamples/SharedGalleryImage_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions/{galleryImageVersionName}": { + "get": { + "tags": [ + "SharedGalleryImageVersions" + ], + "operationId": "SharedGalleryImageVersions_Get", + "description": "Get a shared gallery image version by subscription id or tenant id.", + "parameters": [ + { + "$ref": "../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./galleryRPCommon.json#/parameters/LocationNameParameter" + }, + { + "$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Gallery Image Definition from which the Image Versions are to be listed." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common-types/v1/common.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a shared gallery image version.": { + "$ref": "./examples/sharedGalleryExamples/SharedGalleryImageVersion_Get.json" + } + } + } + } + }, + "definitions": { + "PirResource": { + "description": "The Resource model definition.", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + } + } + }, + "PirSharedGalleryResource": { + "properties": { + "identifier": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryIdentifier" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirResource" + } + ], + "description": "Base information about the shared gallery resource in pir." + }, + "SharedGalleryArtifactTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The artifact tags of a shared gallery resource." + }, + "SharedGalleryIdentifier": { + "properties": { + "uniqueId": { + "type": "string", + "description": "The unique id of this shared gallery." + } + }, + "description": "The identifier information of shared gallery." + }, + "SharedGalleryList": { + "description": "The List Shared Galleries operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGallery" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of shared galleries." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of shared galleries. Call ListNext() with this to fetch the next page of shared galleries." + } + }, + "required": [ + "value" + ] + }, + "SharedGallery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirSharedGalleryResource" + } + ], + "description": "Specifies information about the Shared Gallery that you want to create or update." + }, + "SharedGalleryProperties": { + "type": "object", + "properties": { + "artifactTags": { + "readOnly": true, + "$ref": "#/definitions/SharedGalleryArtifactTags" + } + }, + "description": "Specifies the properties of a shared gallery" + }, + "SharedGalleryImageList": { + "description": "The List Shared Gallery Images operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGalleryImage" + }, + "x-ms-identifiers": [], + "description": "A list of shared gallery images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of shared gallery images. Call ListNext() with this to fetch the next page of shared gallery images." + } + }, + "required": [ + "value" + ] + }, + "SharedGalleryImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirSharedGalleryResource" + } + ], + "description": "Specifies information about the gallery image definition that you want to create or update." + }, + "SharedGalleryImageProperties": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "identifier": { + "$ref": "./galleryRPCommon.json#/definitions/GalleryImageIdentifier" + }, + "recommended": { + "$ref": "./galleryRPCommon.json#/definitions/RecommendedMachineConfiguration" + }, + "disallowed": { + "$ref": "./galleryRPCommon.json#/definitions/Disallowed" + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "features": { + "type": "array", + "items": { + "$ref": "./galleryRPCommon.json#/definitions/GalleryImageFeature" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "A list of gallery image features." + }, + "purchasePlan": { + "$ref": "./galleryRPCommon.json#/definitions/ImagePurchasePlan" + }, + "architecture": { + "$ref": "./galleryRPCommon.json#/definitions/Architecture" + }, + "privacyStatementUri": { + "type": "string", + "description": "Privacy statement uri for the current community gallery image." + }, + "eula": { + "type": "string", + "description": "End-user license agreement for the current community gallery image." + }, + "artifactTags": { + "$ref": "#/definitions/SharedGalleryArtifactTags" + } + }, + "required": [ + "osType", + "osState", + "identifier" + ], + "description": "Describes the properties of a gallery image definition." + }, + "SharedGalleryImageVersionList": { + "description": "The List Shared Gallery Image versions operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGalleryImageVersion" + }, + "x-ms-identifiers": [], + "description": "A list of shared gallery images versions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of shared gallery image versions. Call ListNext() with this to fetch the next page of shared gallery image versions." + } + }, + "required": [ + "value" + ] + }, + "SharedGalleryImageVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirSharedGalleryResource" + } + ], + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "SharedGalleryImageVersionProperties": { + "properties": { + "publishedDate": { + "type": "string", + "format": "date-time", + "description": "The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "excludeFromLatest": { + "type": "boolean", + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "storageProfile": { + "$ref": "./galleryRPCommon.json#/definitions/SharedGalleryImageVersionStorageProfile", + "description": "Describes the storage profile of the image version." + }, + "artifactTags": { + "$ref": "#/definitions/SharedGalleryArtifactTags" + } + }, + "description": "Describes the properties of a gallery image version." + } + } +} diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index d2aad8d5c5e6..c040d782d4c6 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -34,7 +34,7 @@ These are the global settings for the Compute API. title: ComputeManagementClient description: Compute Client openapi-type: arm -tag: package-2023-07-01 +tag: package-2023-09-01 directive: - where: @@ -242,11 +242,125 @@ directive: - suppress: ResourceNameRestriction from: virtualMachineScaleSet.json reason: there is no VMSS naming requirement. It only follows ARM resource naming requirement. + - suppress: ResourceNameRestriction + from: virtualMachine.json + reason: there is no Compute VM naming requirement. It only follows ARM resource naming requirement. - suppress: ArmResourcePropertiesBag reason: This was an existing definition. Too much impact to go through breaking change to address this. from: virtualMachineScaleSet.json where: - $.definitions.VirtualMachineScaleSetVMExtension + - suppress: LroErrorContent + reason: Compute uses common types defined in our own common-types.json. + - suppress: ResourceNameRestriction + from: dedicatedHost.json + reason: there is no dedicated host naming requirement. It only follows ARM resource naming requirement. +``` + +### Tag: package-2023-09-01 + +These settings apply only when `--tag=package-2023-09-01` is specified on the command line. + +``` yaml $(tag) == 'package-2023-09-01' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/computeRPCommon.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachine.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineImage.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineExtensionImage.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/availabilitySet.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/proximityPlacementGroup.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/dedicatedHost.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/sshPublicKey.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/image.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/restorePoint.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/capacityReservation.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/logAnalytic.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/runCommand.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json + - Microsoft.Compute/Skus/stable/2021-07-01/skus.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json + - Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json +``` + +### Tag: package-2023-09-01-only + +These settings apply only when `--tag=package-2023-09-01-only` is specified on the command line. + +```yaml $(tag) == 'package-2023-09-01-only' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/computeRPCommon.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineScaleSet.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachine.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineImage.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/virtualMachineExtensionImage.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/availabilitySet.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/proximityPlacementGroup.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/dedicatedHost.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/sshPublicKey.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/image.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/restorePoint.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/capacityReservation.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/logAnalytic.json + - Microsoft.Compute/ComputeRP/stable/2023-09-01/runCommand.json +``` + +### Tag: package-2022-08-03 + +These settings apply only when `--tag=package-2022-08-03` is specified on the command line. + +``` yaml $(tag) == 'package-2022-08-03' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/computeRPCommon.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachine.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineImage.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineExtensionImage.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/availabilitySet.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/proximityPlacementGroup.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/dedicatedHost.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/sshPublicKey.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/image.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/restorePoint.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/capacityReservation.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/logAnalytic.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/runCommand.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskRPCommon.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/disk.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskAccess.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskEncryptionSet.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/diskRestorePoint.json + - Microsoft.Compute/DiskRP/stable/2023-04-02/snapshot.json + - Microsoft.Compute/Skus/stable/2021-07-01/skus.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json + - Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json +``` + +### Tag: package-2022-08-03-only + +These settings apply only when `--tag=package-2022-08-03-only` is specified on the command line. + +```yaml $(tag) == 'package-2022-08-03-only' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/galleryRPCommon.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/gallery.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/sharedGallery.json + - Microsoft.Compute/GalleryRP/stable/2022-08-03/communityGallery.json ``` ### Tag: package-2023-07-01 @@ -284,6 +398,29 @@ input-file: - Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json ``` +### Tag: package-2023-07-01-only + +These settings apply only when `--tag=package-2023-07-01-only` is specified on the command line. + +```yaml $(tag) == 'package-2023-07-01-only' +input-file: + - Microsoft.Compute/common-types/v1/common.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/computeRPCommon.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachine.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineImage.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineExtensionImage.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/availabilitySet.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/proximityPlacementGroup.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/dedicatedHost.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/sshPublicKey.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/image.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/restorePoint.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/capacityReservation.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/logAnalytic.json + - Microsoft.Compute/ComputeRP/stable/2023-07-01/runCommand.json +``` + ### Tag: package-2023-04-02 These settings apply only when `--tag=package-2023-04-02` is specified on the command line. @@ -319,29 +456,6 @@ input-file: - Microsoft.Compute/CloudserviceRP/stable/2022-09-04/cloudService.json ``` -### Tag: package-2023-07-01-only - -These settings apply only when `--tag=package-2023-07-01-only` is specified on the command line. - -```yaml $(tag) == 'package-2023-07-01-only' -input-file: - - Microsoft.Compute/common-types/v1/common.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/computeRPCommon.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineScaleSet.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachine.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineImage.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/virtualMachineExtensionImage.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/availabilitySet.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/proximityPlacementGroup.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/dedicatedHost.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/sshPublicKey.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/image.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/restorePoint.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/capacityReservation.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/logAnalytic.json - - Microsoft.Compute/ComputeRP/stable/2023-07-01/runCommand.json -``` - ### Tag: package-2023-04-02-only These settings apply only when `--tag=package-2023-04-02-only` is specified on the command line. diff --git a/specification/containerstorage/resource-manager/readme.java.md b/specification/containerstorage/resource-manager/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/containerstorage/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/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 new file mode 100644 index 000000000000..3099c62c63bf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/cosmos-db.json @@ -0,0 +1,10223 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2023-11-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}": { + "get": { + "operationId": "DatabaseAccounts_Get", + "x-ms-examples": { + "CosmosDBDatabaseAccountGet": { + "$ref": "./examples/CosmosDBDatabaseAccountGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The database account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountGetResults" + } + } + } + }, + "patch": { + "operationId": "DatabaseAccounts_Update", + "x-ms-examples": { + "CosmosDBDatabaseAccountPatch": { + "$ref": "./examples/CosmosDBDatabaseAccountPatch.json" + } + }, + "description": "Updates the properties of an existing Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseAccountUpdateParameters" + }, + "description": "The parameters to provide for the current database account." + } + ], + "responses": { + "200": { + "description": "The database account update operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DatabaseAccountGetResults" + } + } + } + }, + "put": { + "operationId": "DatabaseAccounts_CreateOrUpdate", + "x-ms-examples": { + "CosmosDBDatabaseAccountCreateMin": { + "$ref": "./examples/CosmosDBDatabaseAccountCreateMin.json" + }, + "CosmosDBDatabaseAccountCreateMax": { + "$ref": "./examples/CosmosDBDatabaseAccountCreateMax.json" + }, + "CosmosDBRestoreDatabaseAccountCreateUpdate.json": { + "$ref": "./examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json" + } + }, + "description": "Creates or updates an Azure Cosmos DB database account. The \"Update\" method is preferred when performing updates on an account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseAccountCreateUpdateParameters" + }, + "description": "The parameters to provide for the current database account." + } + ], + "responses": { + "200": { + "description": "The database account create or update operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DatabaseAccountGetResults" + } + } + } + }, + "delete": { + "operationId": "DatabaseAccounts_Delete", + "x-ms-examples": { + "CosmosDBDatabaseAccountDelete": { + "$ref": "./examples/CosmosDBDatabaseAccountDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The database account delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The specified account does not exist in the subscription." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange": { + "post": { + "operationId": "DatabaseAccounts_FailoverPriorityChange", + "x-ms-examples": { + "CosmosDBDatabaseAccountFailoverPriorityChange": { + "$ref": "./examples/CosmosDBDatabaseAccountFailoverPriorityChange.json" + } + }, + "description": "Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "failoverParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverPolicies" + }, + "description": "The new failover policies for the database account." + } + ], + "responses": { + "202": { + "description": "Accepted. The failover policy change operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts": { + "get": { + "operationId": "DatabaseAccounts_List", + "x-ms-examples": { + "CosmosDBDatabaseAccountList": { + "$ref": "./examples/CosmosDBDatabaseAccountList.json" + } + }, + "description": "Lists all the Azure Cosmos DB database accounts available under the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts": { + "get": { + "operationId": "DatabaseAccounts_ListByResourceGroup", + "x-ms-examples": { + "CosmosDBDatabaseAccountListByResourceGroup": { + "$ref": "./examples/CosmosDBDatabaseAccountListByResourceGroup.json" + } + }, + "description": "Lists all the Azure Cosmos DB database accounts available under the given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys": { + "post": { + "operationId": "DatabaseAccounts_ListKeys", + "x-ms-examples": { + "CosmosDBDatabaseAccountListKeys": { + "$ref": "./examples/CosmosDBDatabaseAccountListKeys.json" + } + }, + "description": "Lists the access keys for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings": { + "post": { + "operationId": "DatabaseAccounts_ListConnectionStrings", + "x-ms-examples": { + "CosmosDBDatabaseAccountListConnectionStrings": { + "$ref": "./examples/CosmosDBDatabaseAccountListConnectionStrings.json" + }, + "CosmosDBDatabaseAccountListConnectionStringsMongo": { + "$ref": "./examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json" + } + }, + "description": "Lists the connection strings for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListConnectionStringsResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion": { + "post": { + "operationId": "DatabaseAccounts_OfflineRegion", + "x-ms-examples": { + "CosmosDBDatabaseAccountOfflineRegion": { + "$ref": "./examples/CosmosDBDatabaseAccountOfflineRegion.json" + } + }, + "description": "Offline the specified region for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "regionParameterForOffline", + "in": "body", + "required": true, + "description": "Cosmos DB region to offline for the database account.", + "schema": { + "$ref": "#/definitions/RegionForOnlineOffline" + } + } + ], + "responses": { + "200": { + "description": "The offline region operation is completed successfully." + }, + "202": { + "description": "Accepted. The offline region operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion": { + "post": { + "operationId": "DatabaseAccounts_OnlineRegion", + "x-ms-examples": { + "CosmosDBDatabaseAccountOnlineRegion": { + "$ref": "./examples/CosmosDBDatabaseAccountOnlineRegion.json" + } + }, + "description": "Online the specified region for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "regionParameterForOnline", + "in": "body", + "required": true, + "description": "Cosmos DB region to online for the database account.", + "schema": { + "$ref": "#/definitions/RegionForOnlineOffline" + } + } + ], + "responses": { + "200": { + "description": "The online region operation is completed successfully." + }, + "202": { + "description": "Accepted. The online region operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys": { + "get": { + "operationId": "DatabaseAccounts_GetReadOnlyKeys", + "x-ms-examples": { + "CosmosDBDatabaseAccountListReadOnlyKeys": { + "$ref": "./examples/CosmosDBDatabaseAccountListReadOnlyKeys.json" + } + }, + "description": "Lists the read-only access keys for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListReadOnlyKeysResult" + } + } + } + }, + "post": { + "operationId": "DatabaseAccounts_ListReadOnlyKeys", + "x-ms-examples": { + "CosmosDBDatabaseAccountListReadOnlyKeys": { + "$ref": "./examples/CosmosDBDatabaseAccountListReadOnlyKeys.json" + } + }, + "description": "Lists the read-only access keys for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListReadOnlyKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey": { + "post": { + "operationId": "DatabaseAccounts_RegenerateKey", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegenerateKey": { + "$ref": "./examples/CosmosDBDatabaseAccountRegenerateKey.json" + } + }, + "description": "Regenerates an access key for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "keyToRegenerate", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseAccountRegenerateKeyParameters" + }, + "description": "The name of the key to regenerate." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The regenerate key operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + } + } + } + }, + "/providers/Microsoft.DocumentDB/databaseAccountNames/{accountName}": { + "head": { + "operationId": "DatabaseAccounts_CheckNameExists", + "x-ms-examples": { + "CosmosDBDatabaseAccountCheckNameExists": { + "$ref": "./examples/CosmosDBDatabaseAccountCheckNameExists.json" + } + }, + "description": "Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.", + "parameters": [ + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The account name is valid but is already in use." + }, + "404": { + "description": "Not Found. The account name is available and valid." + } + } + } + }, + "/providers/Microsoft.DocumentDB/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Cosmos DB Resource Provider operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "CosmosDBOperationsList": { + "$ref": "./examples/CosmosDBOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics": { + "get": { + "operationId": "DatabaseAccounts_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountGetMetrics": { + "$ref": "./examples/CosmosDBDatabaseAccountGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics": { + "get": { + "operationId": "Database_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseGetMetrics": { + "$ref": "./examples/CosmosDBDatabaseGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account and database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics": { + "get": { + "operationId": "Collection_ListMetrics", + "x-ms-examples": { + "CosmosDBCollectionGetMetrics": { + "$ref": "./examples/CosmosDBCollectionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account and collection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics": { + "get": { + "operationId": "CollectionRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBRegionCollectionGetMetrics": { + "$ref": "./examples/CosmosDBRegionCollectionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account, collection and region.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics": { + "get": { + "operationId": "DatabaseAccountRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBDatabaseAccountRegionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account and region.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics": { + "get": { + "operationId": "PercentileSourceTarget_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPercentileSourceTargetGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/sourceRegionParameter" + }, + { + "$ref": "#/parameters/targetRegionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The percentile metrics for the account, source and target regions were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PercentileMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics": { + "get": { + "operationId": "PercentileTarget_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPercentileTargetGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/targetRegionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The percentile metrics for the account and target regions were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PercentileMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics": { + "get": { + "operationId": "Percentile_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPercentileGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The percentile metrics for the account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PercentileMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics": { + "get": { + "operationId": "CollectionPartitionRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBCollectionPartitionRegionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given collection and region, split by partition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the collection and region were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics": { + "get": { + "operationId": "CollectionPartition_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBCollectionPartitionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given collection, split by partition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the collection were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics": { + "get": { + "operationId": "PartitionKeyRangeId_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPKeyRangeIdGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given partition key range id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "#/parameters/partitionKeyRangeIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the partition key range id were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics": { + "get": { + "operationId": "PartitionKeyRangeIdRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPKeyRangeIdRegionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given partition key range id and region.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "#/parameters/partitionKeyRangeIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the partition key range id and region were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages": { + "get": { + "operationId": "DatabaseAccounts_ListUsages", + "x-ms-examples": { + "CosmosDBDatabaseAccountGetUsages": { + "$ref": "./examples/CosmosDBDatabaseAccountGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent data) for the given database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages": { + "get": { + "operationId": "Database_ListUsages", + "x-ms-examples": { + "CosmosDBDatabaseGetUsages": { + "$ref": "./examples/CosmosDBDatabaseGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent data) for the given database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the database were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages": { + "get": { + "operationId": "Collection_ListUsages", + "x-ms-examples": { + "CosmosDBCollectionGetUsages": { + "$ref": "./examples/CosmosDBCollectionGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent storage data) for the given collection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the collection were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages": { + "get": { + "operationId": "CollectionPartition_ListUsages", + "x-ms-examples": { + "CosmosDBCollectionGetUsages": { + "$ref": "./examples/CosmosDBCollectionPartitionGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent storage data) for the given collection, split by partition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the collection, per partition were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions": { + "get": { + "operationId": "Database_ListMetricDefinitions", + "x-ms-examples": { + "CosmosDBDatabaseGetMetricDefinitions": { + "$ref": "./examples/CosmosDBDatabaseGetMetricDefinitions.json" + } + }, + "description": "Retrieves metric definitions for the given database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric definitions for the database were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricDefinitionsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions": { + "get": { + "operationId": "Collection_ListMetricDefinitions", + "x-ms-examples": { + "CosmosDBCollectionGetMetricDefinitions": { + "$ref": "./examples/CosmosDBCollectionGetMetricDefinitions.json" + } + }, + "description": "Retrieves metric definitions for the given collection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric definitions for the collection were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricDefinitionsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions": { + "get": { + "operationId": "DatabaseAccounts_ListMetricDefinitions", + "x-ms-examples": { + "CosmosDBDatabaseAccountGetMetricDefinitions": { + "$ref": "./examples/CosmosDBDatabaseAccountGetMetricDefinitions.json" + } + }, + "description": "Retrieves metric definitions for the given database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric definitions for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricDefinitionsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases": { + "get": { + "operationId": "SqlResources_ListSqlDatabases", + "x-ms-examples": { + "CosmosDBSqlDatabaseList": { + "$ref": "./examples/CosmosDBSqlDatabaseList.json" + } + }, + "description": "Lists the SQL databases under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL database properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}": { + "get": { + "operationId": "SqlResources_GetSqlDatabase", + "x-ms-examples": { + "CosmosDBSqlDatabaseGet": { + "$ref": "./examples/CosmosDBSqlDatabaseGet.json" + } + }, + "description": "Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL database property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlDatabase", + "x-ms-examples": { + "CosmosDBSqlDatabaseCreateUpdate": { + "$ref": "./examples/CosmosDBSqlDatabaseCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlDatabaseParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlDatabaseCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL database." + } + ], + "responses": { + "202": { + "description": "The SQL database create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL database create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlDatabase", + "x-ms-examples": { + "CosmosDBSqlDatabaseDelete": { + "$ref": "./examples/CosmosDBSqlDatabaseDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL database.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The SQL database delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default": { + "get": { + "operationId": "SqlResources_GetSqlDatabaseThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseThroughputGet": { + "$ref": "./examples/CosmosDBSqlDatabaseThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the SQL database was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_UpdateSqlDatabaseThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseThroughputUpdate": { + "$ref": "./examples/CosmosDBSqlDatabaseThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB SQL database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The parameters to provide for the RUs per second of the current SQL database." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the SQL database update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the SQL database update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "SqlResources_MigrateSqlDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBSqlDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBSqlDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "SqlResources_MigrateSqlDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers": { + "get": { + "operationId": "SqlResources_ListSqlContainers", + "x-ms-examples": { + "CosmosDBSqlContainerList": { + "$ref": "./examples/CosmosDBSqlContainerList.json" + } + }, + "description": "Lists the SQL container under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL container properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlContainerListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}": { + "get": { + "operationId": "SqlResources_GetSqlContainer", + "x-ms-examples": { + "CosmosDBSqlContainerGet": { + "$ref": "./examples/CosmosDBSqlContainerGet.json" + } + }, + "description": "Gets the SQL container under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL container property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlContainerGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlContainer", + "x-ms-examples": { + "CosmosDBSqlContainerCreateUpdate": { + "$ref": "./examples/CosmosDBSqlContainerCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL container", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlContainerParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlContainerCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL container." + } + ], + "responses": { + "202": { + "description": "The SQL container create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL container create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlContainerGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlContainer", + "x-ms-examples": { + "CosmosDBSqlContainerDelete": { + "$ref": "./examples/CosmosDBSqlContainerDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL container.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The SQL container delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default": { + "get": { + "operationId": "SqlResources_GetSqlContainerThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerThroughputGet": { + "$ref": "./examples/CosmosDBSqlContainerThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the SQL container was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_UpdateSqlContainerThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerThroughputUpdate": { + "$ref": "./examples/CosmosDBSqlContainerThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB SQL container", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The parameters to provide for the RUs per second of the current SQL container." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the SQL container update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the SQL container update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "SqlResources_MigrateSqlContainerToAutoscale", + "x-ms-examples": { + "CosmosDBSqlContainerMigrateToAutoscale": { + "$ref": "./examples/CosmosDBSqlContainerMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL container migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "SqlResources_MigrateSqlContainerToManualThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBSqlContainerMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL container migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys": { + "get": { + "operationId": "SqlResources_ListClientEncryptionKeys", + "x-ms-examples": { + "CosmosDBClientEncryptionKeysList": { + "$ref": "./examples/CosmosDBSqlClientEncryptionKeysList.json" + } + }, + "description": "Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The ClientEncryptionKeys were retrieved successfully.", + "schema": { + "$ref": "#/definitions/ClientEncryptionKeysListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}": { + "get": { + "operationId": "SqlResources_GetClientEncryptionKey", + "x-ms-examples": { + "CosmosDBClientEncryptionKeyGet": { + "$ref": "./examples/CosmosDBSqlClientEncryptionKeyGet.json" + } + }, + "description": "Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/clientEncryptionKeyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The ClientEncryptionKey was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ClientEncryptionKeyGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateClientEncryptionKey", + "x-ms-examples": { + "CosmosDBClientEncryptionKeyCreateUpdate": { + "$ref": "./examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json" + } + }, + "description": "Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/clientEncryptionKeyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateClientEncryptionKeyParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClientEncryptionKeyCreateUpdateParameters" + }, + "description": "The parameters to provide for the client encryption key." + } + ], + "responses": { + "202": { + "description": "The client encryption key create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The client encryption key create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ClientEncryptionKeyGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures": { + "get": { + "operationId": "SqlResources_ListSqlStoredProcedures", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureList": { + "$ref": "./examples/CosmosDBSqlStoredProcedureList.json" + } + }, + "description": "Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL stored procedure properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlStoredProcedureListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}": { + "get": { + "operationId": "SqlResources_GetSqlStoredProcedure", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureGet": { + "$ref": "./examples/CosmosDBSqlStoredProcedureGet.json" + } + }, + "description": "Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/storedProcedureNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL storedProcedure property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlStoredProcedureGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlStoredProcedure", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureCreateUpdate": { + "$ref": "./examples/CosmosDBSqlStoredProcedureCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL storedProcedure", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/storedProcedureNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlStoredProcedureParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlStoredProcedureCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL storedProcedure." + } + ], + "responses": { + "202": { + "description": "The SQL storedProcedure create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL storedProcedure create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlStoredProcedureGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlStoredProcedure", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureDelete": { + "$ref": "./examples/CosmosDBSqlStoredProcedureDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL storedProcedure.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/storedProcedureNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL storedProcedure delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The SQL storedProcedure delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions": { + "get": { + "operationId": "SqlResources_ListSqlUserDefinedFunctions", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionList": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionList.json" + } + }, + "description": "Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL userDefinedFunction properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}": { + "get": { + "operationId": "SqlResources_GetSqlUserDefinedFunction", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionGet": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionGet.json" + } + }, + "description": "Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/userDefinedFunctionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL userDefinedFunction property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlUserDefinedFunction", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionCreateUpdate": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL userDefinedFunction", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/userDefinedFunctionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlUserDefinedFunctionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL userDefinedFunction." + } + ], + "responses": { + "202": { + "description": "The SQL userDefinedFunction create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL userDefinedFunction create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlUserDefinedFunction", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionDelete": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL userDefinedFunction.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/userDefinedFunctionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL userDefinedFunction delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The SQL userDefinedFunction delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers": { + "get": { + "operationId": "SqlResources_ListSqlTriggers", + "x-ms-examples": { + "CosmosDBSqlTriggerList": { + "$ref": "./examples/CosmosDBSqlTriggerList.json" + } + }, + "description": "Lists the SQL trigger under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL trigger properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlTriggerListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}": { + "get": { + "operationId": "SqlResources_GetSqlTrigger", + "x-ms-examples": { + "CosmosDBSqlTriggerGet": { + "$ref": "./examples/CosmosDBSqlTriggerGet.json" + } + }, + "description": "Gets the SQL trigger under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/triggerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL trigger property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlTriggerGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlTrigger", + "x-ms-examples": { + "CosmosDBSqlTriggerCreateUpdate": { + "$ref": "./examples/CosmosDBSqlTriggerCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL trigger", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/triggerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlTriggerParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlTriggerCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL trigger." + } + ], + "responses": { + "202": { + "description": "The SQL trigger create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The SQL trigger create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlTriggerGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlTrigger", + "x-ms-examples": { + "CosmosDBSqlTriggerDelete": { + "$ref": "./examples/CosmosDBSqlTriggerDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/triggerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL trigger delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The SQL trigger delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases": { + "get": { + "operationId": "MongoDBResources_ListMongoDBDatabases", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseList": { + "$ref": "./examples/CosmosDBMongoDBDatabaseList.json" + } + }, + "description": "Lists the MongoDB databases under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB database properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBDatabaseListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}": { + "get": { + "operationId": "MongoDBResources_GetMongoDBDatabase", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseGet": { + "$ref": "./examples/CosmosDBMongoDBDatabaseGet.json" + } + }, + "description": "Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB database property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBDatabaseGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_CreateUpdateMongoDBDatabase", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseCreateUpdate": { + "$ref": "./examples/CosmosDBMongoDBDatabaseCreateUpdate.json" + } + }, + "description": "Create or updates Azure Cosmos DB MongoDB database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateMongoDBDatabaseParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MongoDBDatabaseCreateUpdateParameters" + }, + "description": "The parameters to provide for the current MongoDB database." + } + ], + "responses": { + "202": { + "description": "The MongoDB database create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB database create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/MongoDBDatabaseGetResults" + } + } + } + }, + "delete": { + "operationId": "MongoDBResources_DeleteMongoDBDatabase", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseDelete": { + "$ref": "./examples/CosmosDBMongoDBDatabaseDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB MongoDB database.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The MongoDB database delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default": { + "get": { + "operationId": "MongoDBResources_GetMongoDBDatabaseThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseThroughputGet": { + "$ref": "./examples/CosmosDBMongoDBDatabaseThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the MongoDB database was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_UpdateMongoDBDatabaseThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseThroughputUpdate": { + "$ref": "./examples/CosmosDBMongoDBDatabaseThroughputUpdate.json" + } + }, + "description": "Update RUs per second of the an Azure Cosmos DB MongoDB database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current MongoDB database." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the MongoDB database update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the MongoDB database update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections": { + "get": { + "operationId": "MongoDBResources_ListMongoDBCollections", + "x-ms-examples": { + "CosmosDBMongoDBCollectionList": { + "$ref": "./examples/CosmosDBMongoDBCollectionList.json" + } + }, + "description": "Lists the MongoDB collection under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB collection properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}": { + "get": { + "operationId": "MongoDBResources_GetMongoDBCollection", + "x-ms-examples": { + "CosmosDBMongoDBCollectionGet": { + "$ref": "./examples/CosmosDBMongoDBCollectionGet.json" + } + }, + "description": "Gets the MongoDB collection under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB collection property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBCollectionGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_CreateUpdateMongoDBCollection", + "x-ms-examples": { + "CosmosDBMongoDBCollectionCreateUpdate": { + "$ref": "./examples/CosmosDBMongoDBCollectionCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB MongoDB Collection", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateMongoDBCollectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MongoDBCollectionCreateUpdateParameters" + }, + "description": "The parameters to provide for the current MongoDB Collection." + } + ], + "responses": { + "202": { + "description": "The MongoDB Collection create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB Collection create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/MongoDBCollectionGetResults" + } + } + } + }, + "delete": { + "operationId": "MongoDBResources_DeleteMongoDBCollection", + "x-ms-examples": { + "CosmosDBMongoDBCollectionDelete": { + "$ref": "./examples/CosmosDBMongoDBCollectionDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB MongoDB Collection.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB collection delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The MongoDB collection delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default": { + "get": { + "operationId": "MongoDBResources_GetMongoDBCollectionThroughput", + "x-ms-examples": { + "CosmosDBMongoDBCollectionThroughputGet": { + "$ref": "./examples/CosmosDBMongoDBCollectionThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the MongoDB collection was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_UpdateMongoDBCollectionThroughput", + "x-ms-examples": { + "CosmosDBMongoDBCollectionThroughputUpdate": { + "$ref": "./examples/CosmosDBMongoDBCollectionThroughputUpdate.json" + } + }, + "description": "Update the RUs per second of an Azure Cosmos DB MongoDB collection", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current MongoDB collection." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the MongoDB collection update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the MongoDB collection update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBCollectionToAutoscale", + "x-ms-examples": { + "CosmosDBMongoDBCollectionMigrateToAutoscale": { + "$ref": "./examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB collection migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB collection migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBCollectionToManualThroughput", + "x-ms-examples": { + "CosmosDBMongoDBCollectionMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB collection migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The MongoDB collection migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables": { + "get": { + "operationId": "TableResources_ListTables", + "x-ms-examples": { + "CosmosDBTableList": { + "$ref": "./examples/CosmosDBTableList.json" + } + }, + "description": "Lists the Tables under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Table properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/TableListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}": { + "get": { + "operationId": "TableResources_GetTable", + "x-ms-examples": { + "CosmosDBTableGet": { + "$ref": "./examples/CosmosDBTableGet.json" + } + }, + "description": "Gets the Tables under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Table property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/TableGetResults" + } + } + } + }, + "put": { + "operationId": "TableResources_CreateUpdateTable", + "x-ms-examples": { + "CosmosDBTableReplace": { + "$ref": "./examples/CosmosDBTableCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateTableParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TableCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Table." + } + ], + "responses": { + "202": { + "description": "The Table create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Table create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/TableGetResults" + } + } + } + }, + "delete": { + "operationId": "TableResources_DeleteTable", + "x-ms-examples": { + "CosmosDBTableDelete": { + "$ref": "./examples/CosmosDBTableDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Table.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Table delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default": { + "get": { + "operationId": "TableResources_GetTableThroughput", + "x-ms-examples": { + "CosmosDBTableThroughputGet": { + "$ref": "./examples/CosmosDBTableThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Table was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "TableResources_UpdateTableThroughput", + "x-ms-examples": { + "CosmosDBTableThroughputUpdate": { + "$ref": "./examples/CosmosDBTableThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The parameters to provide for the RUs per second of the current Table." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Table update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Table update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "TableResources_MigrateTableToAutoscale", + "x-ms-examples": { + "CosmosDBTableMigrateToAutoscale": { + "$ref": "./examples/CosmosDBTableMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Table from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "TableResources_MigrateTableToManualThroughput", + "x-ms-examples": { + "CosmosDBTableMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBTableMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Table from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces": { + "get": { + "operationId": "CassandraResources_ListCassandraKeyspaces", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceList": { + "$ref": "./examples/CosmosDBCassandraKeyspaceList.json" + } + }, + "description": "Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra keyspace properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraKeyspaceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}": { + "get": { + "operationId": "CassandraResources_GetCassandraKeyspace", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceGet": { + "$ref": "./examples/CosmosDBCassandraKeyspaceGet.json" + } + }, + "description": "Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra keyspace property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraKeyspaceGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_CreateUpdateCassandraKeyspace", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceCreateUpdate": { + "$ref": "./examples/CosmosDBCassandraKeyspaceCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Cassandra keyspace", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateCassandraKeyspaceParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CassandraKeyspaceCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Cassandra keyspace." + } + ], + "responses": { + "202": { + "description": "The Cassandra keyspace create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra keyspace create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/CassandraKeyspaceGetResults" + } + } + } + }, + "delete": { + "operationId": "CassandraResources_DeleteCassandraKeyspace", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceDelete": { + "$ref": "./examples/CosmosDBCassandraKeyspaceDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Cassandra keyspace.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra keyspace delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Cassandra keyspace delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default": { + "get": { + "operationId": "CassandraResources_GetCassandraKeyspaceThroughput", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceThroughputGet": { + "$ref": "./examples/CosmosDBCassandraKeyspaceThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Cassandra Keyspace was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_UpdateCassandraKeyspaceThroughput", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceThroughputUpdate": { + "$ref": "./examples/CosmosDBCassandraKeyspaceThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Cassandra Keyspace", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Cassandra Keyspace." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Cassandra Keyspace update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Cassandra Keyspace update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "CassandraResources_MigrateCassandraKeyspaceToAutoscale", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceMigrateToAutoscale": { + "$ref": "./examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra Keyspace migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra Keyspace migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "CassandraResources_MigrateCassandraKeyspaceToManualThroughput", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra Keyspace migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra Keyspace migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables": { + "get": { + "operationId": "CassandraResources_ListCassandraTables", + "x-ms-examples": { + "CosmosDBCassandraTableList": { + "$ref": "./examples/CosmosDBCassandraTableList.json" + } + }, + "description": "Lists the Cassandra table under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra table properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraTableListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}": { + "get": { + "operationId": "CassandraResources_GetCassandraTable", + "x-ms-examples": { + "CosmosDBCassandraTableGet": { + "$ref": "./examples/CosmosDBCassandraTableGet.json" + } + }, + "description": "Gets the Cassandra table under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra table property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraTableGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_CreateUpdateCassandraTable", + "x-ms-examples": { + "CosmosDBCassandraTableCreateUpdate": { + "$ref": "./examples/CosmosDBCassandraTableCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Cassandra Table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateCassandraTableParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CassandraTableCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Cassandra Table." + } + ], + "responses": { + "202": { + "description": "The Cassandra Table create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra Table create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/CassandraTableGetResults" + } + } + } + }, + "delete": { + "operationId": "CassandraResources_DeleteCassandraTable", + "x-ms-examples": { + "CosmosDBCassandraTableDelete": { + "$ref": "./examples/CosmosDBCassandraTableDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Cassandra table.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Cassandra table delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default": { + "get": { + "operationId": "CassandraResources_GetCassandraTableThroughput", + "x-ms-examples": { + "CosmosDBCassandraTableThroughputGet": { + "$ref": "./examples/CosmosDBCassandraTableThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Cassandra table was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_UpdateCassandraTableThroughput", + "x-ms-examples": { + "CosmosDBCassandraTableThroughputUpdate": { + "$ref": "./examples/CosmosDBCassandraTableThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Cassandra table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Cassandra table." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Cassandra table update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Cassandra table update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "CassandraResources_MigrateCassandraTableToAutoscale", + "x-ms-examples": { + "CosmosDBCassandraTableMigrateToAutoscale": { + "$ref": "./examples/CosmosDBCassandraTableMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "CassandraResources_MigrateCassandraTableToManualThroughput", + "x-ms-examples": { + "CosmosDBCassandraTableMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBCassandraTableMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Cassandra table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases": { + "get": { + "operationId": "GremlinResources_ListGremlinDatabases", + "x-ms-examples": { + "CosmosDBGremlinDatabaseList": { + "$ref": "./examples/CosmosDBGremlinDatabaseList.json" + } + }, + "description": "Lists the Gremlin databases under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin database properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinDatabaseListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}": { + "get": { + "operationId": "GremlinResources_GetGremlinDatabase", + "x-ms-examples": { + "CosmosDBGremlinDatabaseGet": { + "$ref": "./examples/CosmosDBGremlinDatabaseGet.json" + } + }, + "description": "Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin database property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinDatabaseGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_CreateUpdateGremlinDatabase", + "x-ms-examples": { + "CosmosDBGremlinDatabaseCreateUpdate": { + "$ref": "./examples/CosmosDBGremlinDatabaseCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Gremlin database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateGremlinDatabaseParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GremlinDatabaseCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Gremlin database." + } + ], + "responses": { + "202": { + "description": "The Gremlin database create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin database create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/GremlinDatabaseGetResults" + } + } + } + }, + "delete": { + "operationId": "GremlinResources_DeleteGremlinDatabase", + "x-ms-examples": { + "CosmosDBGremlinDatabaseDelete": { + "$ref": "./examples/CosmosDBGremlinDatabaseDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Gremlin database.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Gremlin database delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default": { + "get": { + "operationId": "GremlinResources_GetGremlinDatabaseThroughput", + "x-ms-examples": { + "CosmosDBGremlinDatabaseThroughputGet": { + "$ref": "./examples/CosmosDBGremlinDatabaseThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Gremlin database was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_UpdateGremlinDatabaseThroughput", + "x-ms-examples": { + "CosmosDBGremlinDatabaseThroughputUpdate": { + "$ref": "./examples/CosmosDBGremlinDatabaseThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Gremlin database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Gremlin database." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Gremlin database update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Gremlin database update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "GremlinResources_MigrateGremlinDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBGremlinDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "GremlinResources_MigrateGremlinDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBGremlinDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs": { + "get": { + "operationId": "GremlinResources_ListGremlinGraphs", + "x-ms-examples": { + "CosmosDBGremlinGraphList": { + "$ref": "./examples/CosmosDBGremlinGraphList.json" + } + }, + "description": "Lists the Gremlin graph under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin graph properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinGraphListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}": { + "get": { + "operationId": "GremlinResources_GetGremlinGraph", + "x-ms-examples": { + "CosmosDBGremlinGraphGet": { + "$ref": "./examples/CosmosDBGremlinGraphGet.json" + } + }, + "description": "Gets the Gremlin graph under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin graph property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinGraphGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_CreateUpdateGremlinGraph", + "x-ms-examples": { + "CosmosDBGremlinGraphCreateUpdate": { + "$ref": "./examples/CosmosDBGremlinGraphCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Gremlin graph", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateGremlinGraphParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GremlinGraphCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Gremlin graph." + } + ], + "responses": { + "202": { + "description": "The Gremlin graph create or update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin graph create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/GremlinGraphGetResults" + } + } + } + }, + "delete": { + "operationId": "GremlinResources_DeleteGremlinGraph", + "x-ms-examples": { + "CosmosDBGremlinGraphDelete": { + "$ref": "./examples/CosmosDBGremlinGraphDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Gremlin graph.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph delete operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The Gremlin graph delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default": { + "get": { + "operationId": "GremlinResources_GetGremlinGraphThroughput", + "x-ms-examples": { + "CosmosDBGremlinGraphThroughputGet": { + "$ref": "./examples/CosmosDBGremlinGraphThroughputGet.json" + } + }, + "description": "Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Gremlin graph was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_UpdateGremlinGraphThroughput", + "x-ms-examples": { + "CosmosDBGremlinGraphThroughputUpdate": { + "$ref": "./examples/CosmosDBGremlinGraphThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Gremlin graph", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Gremlin graph." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Gremlin graph update operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The RUs per second of the Gremlin graph update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "GremlinResources_MigrateGremlinGraphToAutoscale", + "x-ms-examples": { + "CosmosDBGremlinGraphMigrateToAutoscale": { + "$ref": "./examples/CosmosDBGremlinGraphMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin graph migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "GremlinResources_MigrateGremlinGraphToManualThroughput", + "x-ms-examples": { + "CosmosDBGremlinGraphMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBGremlinGraphMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph migrate operation will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "200": { + "description": "The Gremlin graph migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations": { + "get": { + "operationId": "Locations_List", + "x-ms-examples": { + "CosmosDBLocationList": { + "$ref": "./examples/CosmosDBLocationList.json" + } + }, + "description": "List Cosmos DB locations and their properties", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/LocationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}": { + "get": { + "operationId": "Locations_Get", + "x-ms-examples": { + "CosmosDBLocationGet": { + "$ref": "./examples/CosmosDBLocationGet.json" + } + }, + "description": "Get the properties of an existing Cosmos DB location", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "The Cosmos DB location properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/LocationGetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ClientEncryptionKeysListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ClientEncryptionKeyGetResults" + }, + "description": "List of client encryption keys and their properties." + } + }, + "description": "The List operation response, that contains the client encryption keys and their properties." + }, + "DatabaseAccountsListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseAccountGetResults" + }, + "description": "List of database account and their properties." + } + }, + "description": "The List operation response, that contains the database accounts and their properties." + }, + "SqlDatabaseListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlDatabaseGetResults" + }, + "description": "List of SQL databases and their properties." + } + }, + "description": "The List operation response, that contains the SQL databases and their properties." + }, + "SqlContainerListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlContainerGetResults" + }, + "description": "List of containers and their properties." + } + }, + "description": "The List operation response, that contains the containers and their properties." + }, + "SqlStoredProcedureListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlStoredProcedureGetResults" + }, + "description": "List of storedProcedures and their properties." + } + }, + "description": "The List operation response, that contains the storedProcedures and their properties." + }, + "SqlUserDefinedFunctionListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlUserDefinedFunctionGetResults" + }, + "description": "List of userDefinedFunctions and their properties." + } + }, + "description": "The List operation response, that contains the userDefinedFunctions and their properties." + }, + "SqlTriggerListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlTriggerGetResults" + }, + "description": "List of triggers and their properties." + } + }, + "description": "The List operation response, that contains the triggers and their properties." + }, + "MongoDBDatabaseListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MongoDBDatabaseGetResults" + }, + "description": "List of MongoDB databases and their properties." + } + }, + "description": "The List operation response, that contains the MongoDB databases and their properties." + }, + "MongoDBCollectionListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MongoDBCollectionGetResults" + }, + "description": "List of MongoDB collections and their properties." + } + }, + "description": "The List operation response, that contains the MongoDB collections and their properties." + }, + "TableListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TableGetResults" + }, + "description": "List of Table and their properties." + } + }, + "description": "The List operation response, that contains the Table and their properties." + }, + "CassandraKeyspaceListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CassandraKeyspaceGetResults" + }, + "description": "List of Cassandra keyspaces and their properties." + } + }, + "description": "The List operation response, that contains the Cassandra keyspaces and their properties." + }, + "CassandraTableListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CassandraTableGetResults" + }, + "description": "List of Cassandra tables and their properties." + } + }, + "description": "The List operation response, that contains the Cassandra tables and their properties." + }, + "GremlinDatabaseListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/GremlinDatabaseGetResults" + }, + "description": "List of Gremlin databases and their properties." + } + }, + "description": "The List operation response, that contains the Gremlin databases and their properties." + }, + "GremlinGraphListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/GremlinGraphGetResults" + }, + "description": "List of graphs and their properties." + } + }, + "description": "The List operation response, that contains the graphs and their properties." + }, + "ErrorResponse": { + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + }, + "description": "Error Response." + }, + "CloudError": { + "x-ms-external": true, + "description": "An error response from the service.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "FailoverPolicies": { + "properties": { + "failoverPolicies": { + "type": "array", + "description": "List of failover policies.", + "items": { + "$ref": "#/definitions/FailoverPolicy" + } + } + }, + "required": [ + "failoverPolicies" + ], + "description": "The list of new failover policies for the failover priority change." + }, + "FailoverPolicy": { + "type": "object", + "description": "The failover policy for a given region of a database account.", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>." + }, + "locationName": { + "type": "string", + "description": "The name of the region in which the database account exists." + }, + "failoverPriority": { + "type": "integer", + "minimum": 0, + "format": "int32", + "description": "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists." + } + } + }, + "RegionForOnlineOffline": { + "properties": { + "region": { + "type": "string", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + } + }, + "required": [ + "region" + ], + "description": "Cosmos DB region to online or offline." + }, + "Location": { + "description": "A region in which the Azure Cosmos DB database account is deployed.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The unique identifier of the region within the database account. Example: <accountName>-<locationName>." + }, + "locationName": { + "type": "string", + "description": "The name of the region." + }, + "documentEndpoint": { + "type": "string", + "readOnly": true, + "description": "The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "failoverPriority": { + "description": "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.", + "format": "int32", + "type": "integer", + "minimum": 0 + }, + "isZoneRedundant": { + "type": "boolean", + "description": "Flag to indicate whether or not this region is an AvailabilityZone region" + } + } + }, + "ARMResourceProperties": { + "type": "object", + "description": "The core properties of ARM resources.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "$ref": "#/definitions/Tags" + } + }, + "x-ms-azure-resource": true + }, + "ARMProxyResource": { + "type": "object", + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the database account." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the database account." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + }, + "x-ms-azure-resource": true + }, + "ClientEncryptionKeyCreateUpdateParameters": { + "description": "Parameters to create and update ClientEncryptionKey.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update ClientEncryptionKey.", + "$ref": "#/definitions/ClientEncryptionKeyCreateUpdateProperties" + } + }, + "required": [ + "properties" + ] + }, + "ClientEncryptionKeyCreateUpdateProperties": { + "description": "Properties to create and update ClientEncryptionKey.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a ClientEncryptionKey", + "$ref": "#/definitions/ClientEncryptionKeyResource" + } + }, + "required": [ + "resource" + ] + }, + "ClientEncryptionKeyGetResults": { + "description": "Client Encryption Key.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of a ClientEncryptionKey", + "$ref": "#/definitions/ClientEncryptionKeyGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMProxyResource" + } + ] + }, + "ClientEncryptionKeyGetProperties": { + "description": "The properties of a ClientEncryptionKey resource", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/ClientEncryptionKeyResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "DatabaseAccountGetResults": { + "description": "An Azure Cosmos DB database account.", + "type": "object", + "properties": { + "kind": { + "description": "Indicates the type of database account. This can only be set at database account creation.", + "type": "string", + "default": "GlobalDocumentDB", + "enum": [ + "GlobalDocumentDB", + "MongoDB", + "Parse" + ], + "x-ms-enum": { + "name": "DatabaseAccountKind", + "modelAsString": true + } + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseAccountGetProperties" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "ExtendedResourceProperties": { + "description": "The system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs.", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "description": "A system generated property. A unique identifier.", + "readOnly": true + }, + "_ts": { + "type": "number", + "description": "A system generated property that denotes the last updated timestamp of the resource.", + "readOnly": true + }, + "_etag": { + "type": "string", + "description": "A system generated property representing the resource etag required for optimistic concurrency control.", + "readOnly": true + } + } + }, + "ThroughputSettingsGetResults": { + "description": "An Azure Cosmos DB resource throughput.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB resource throughput", + "$ref": "#/definitions/ThroughputSettingsGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "ThroughputSettingsGetProperties": { + "description": "The properties of an Azure Cosmos DB resource throughput", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/ThroughputSettingsResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "SqlDatabaseGetResults": { + "description": "An Azure Cosmos DB SQL database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB SQL database", + "$ref": "#/definitions/SqlDatabaseGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlDatabaseGetProperties": { + "description": "The properties of an Azure Cosmos DB SQL database", + "type": "object", + "properties": { + "resource": { + "properties": { + "_colls": { + "type": "string", + "description": "A system generated property that specified the addressable path of the collections resource." + }, + "_users": { + "type": "string", + "description": "A system generated property that specifies the addressable path of the users resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SqlDatabaseResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "SqlContainerGetResults": { + "description": "An Azure Cosmos DB container.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB container", + "$ref": "#/definitions/SqlContainerGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlContainerGetProperties": { + "description": "The properties of an Azure Cosmos DB container", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlContainerResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "SqlStoredProcedureGetResults": { + "description": "An Azure Cosmos DB storedProcedure.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB storedProcedure", + "$ref": "#/definitions/SqlStoredProcedureGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlStoredProcedureGetProperties": { + "description": "The properties of an Azure Cosmos DB StoredProcedure", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlStoredProcedureResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "SqlUserDefinedFunctionGetResults": { + "description": "An Azure Cosmos DB userDefinedFunction.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB userDefinedFunction", + "$ref": "#/definitions/SqlUserDefinedFunctionGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlUserDefinedFunctionGetProperties": { + "description": "The properties of an Azure Cosmos DB userDefinedFunction", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlUserDefinedFunctionResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "SqlTriggerGetResults": { + "description": "An Azure Cosmos DB trigger.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB trigger", + "$ref": "#/definitions/SqlTriggerGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlTriggerGetProperties": { + "description": "The properties of an Azure Cosmos DB trigger", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlTriggerResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "MongoDBDatabaseGetResults": { + "description": "An Azure Cosmos DB MongoDB database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB MongoDB database", + "$ref": "#/definitions/MongoDBDatabaseGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "MongoDBDatabaseGetProperties": { + "description": "The properties of an Azure Cosmos DB MongoDB database", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/MongoDBDatabaseResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "MongoDBCollectionGetResults": { + "description": "An Azure Cosmos DB MongoDB collection.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB MongoDB collection", + "$ref": "#/definitions/MongoDBCollectionGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "MongoDBCollectionGetProperties": { + "description": "The properties of an Azure Cosmos DB MongoDB collection", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/MongoDBCollectionResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "TableGetResults": { + "description": "An Azure Cosmos DB Table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Table", + "$ref": "#/definitions/TableGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "TableGetProperties": { + "description": "The properties of an Azure Cosmos Table", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/TableResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "CassandraKeyspaceGetResults": { + "description": "An Azure Cosmos DB Cassandra keyspace.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Cassandra keyspace", + "$ref": "#/definitions/CassandraKeyspaceGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "CassandraKeyspaceGetProperties": { + "description": "The properties of an Azure Cosmos DB Cassandra keyspace", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/CassandraKeyspaceResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "CassandraTableGetResults": { + "description": "An Azure Cosmos DB Cassandra table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Cassandra table", + "$ref": "#/definitions/CassandraTableGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "CassandraTableGetProperties": { + "description": "The properties of an Azure Cosmos DB Cassandra table", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/CassandraTableResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "GremlinDatabaseGetResults": { + "description": "An Azure Cosmos DB Gremlin database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB SQL database", + "$ref": "#/definitions/GremlinDatabaseGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "GremlinDatabaseGetProperties": { + "description": "The properties of an Azure Cosmos DB SQL database", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/GremlinDatabaseResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "GremlinGraphGetResults": { + "description": "An Azure Cosmos DB Gremlin graph.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Gremlin graph", + "$ref": "#/definitions/GremlinGraphGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "GremlinGraphGetProperties": { + "description": "The properties of an Azure Cosmos DB Gremlin graph", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/GremlinGraphResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "ConsistencyPolicy": { + "type": "object", + "description": "The consistency policy for the Cosmos DB database account.", + "properties": { + "defaultConsistencyLevel": { + "description": "The default consistency level and configuration settings of the Cosmos DB account.", + "type": "string", + "enum": [ + "Eventual", + "Session", + "BoundedStaleness", + "Strong", + "ConsistentPrefix" + ], + "x-ms-enum": { + "name": "DefaultConsistencyLevel", + "modelAsString": false + } + }, + "maxStalenessPrefix": { + "description": "When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.", + "type": "integer", + "minimum": 1, + "maximum": 2147483647, + "format": "int64" + }, + "maxIntervalInSeconds": { + "description": "When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.", + "type": "integer", + "minimum": 5, + "maximum": 86400, + "format": "int32" + } + }, + "required": [ + "defaultConsistencyLevel" + ] + }, + "CorsPolicy": { + "type": "object", + "description": "The CORS policy for the Cosmos DB database account.", + "properties": { + "allowedOrigins": { + "description": "The origin domains that are permitted to make a request against the service via CORS.", + "type": "string" + }, + "allowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request.", + "type": "string" + }, + "allowedHeaders": { + "description": "The request headers that the origin domain may specify on the CORS request.", + "type": "string" + }, + "exposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.", + "type": "string" + }, + "maxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 1, + "maximum": 2147483647, + "format": "int64" + } + }, + "required": [ + "allowedOrigins" + ] + }, + "DatabaseAccountGetProperties": { + "description": "Properties for the database account.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "documentEndpoint": { + "description": "The connection endpoint for the Cosmos DB database account.", + "type": "string", + "readOnly": true + }, + "databaseAccountOfferType": { + "description": "The offer type for the Cosmos DB database account. Default value: Standard.", + "readOnly": true, + "$ref": "#/definitions/DatabaseAccountOfferType" + }, + "ipRules": { + "description": "List of IpRules.", + "$ref": "#/definitions/IPRules" + }, + "isVirtualNetworkFilterEnabled": { + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.", + "type": "boolean" + }, + "enableAutomaticFailover": { + "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.", + "type": "boolean" + }, + "consistencyPolicy": { + "description": "The consistency policy for the Cosmos DB database account.", + "$ref": "#/definitions/ConsistencyPolicy" + }, + "capabilities": { + "type": "array", + "description": "List of Cosmos DB capabilities for the account", + "items": { + "$ref": "#/definitions/Capability" + } + }, + "writeLocations": { + "type": "array", + "readOnly": true, + "description": "An array that contains the write location for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "readLocations": { + "type": "array", + "readOnly": true, + "description": "An array that contains of the read locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "failoverPolicies": { + "type": "array", + "readOnly": true, + "description": "An array that contains the regions ordered by their failover priorities.", + "items": { + "$ref": "#/definitions/FailoverPolicy" + } + }, + "virtualNetworkRules": { + "type": "array", + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "description": "List of Private Endpoint Connections configured for the Cosmos DB account.", + "items": { + "$ref": "../../stable/2023-11-15/privateEndpointConnection.json#/definitions/PrivateEndpointConnection" + } + }, + "enableMultipleWriteLocations": { + "description": "Enables the account to write in multiple locations", + "type": "boolean" + }, + "enableCassandraConnector": { + "description": "Enables the cassandra connector on the Cosmos DB C* account", + "type": "boolean" + }, + "connectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB database C* account.", + "$ref": "#/definitions/ConnectorOffer" + }, + "disableKeyBasedMetadataWriteAccess": { + "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys", + "type": "boolean" + }, + "keyVaultKeyUri": { + "description": "The URI of the key vault", + "type": "string" + }, + "defaultIdentity": { + "description": "The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be \"FirstPartyIdentity\", \"SystemAssignedIdentity\" and more.", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "enableFreeTier": { + "description": "Flag to indicate whether Free Tier is enabled.", + "type": "boolean" + }, + "apiProperties": { + "description": "API specific properties.", + "type": "object", + "$ref": "#/definitions/ApiProperties" + }, + "enableAnalyticalStorage": { + "description": "Flag to indicate whether to enable storage analytics.", + "type": "boolean" + }, + "analyticalStorageConfiguration": { + "description": "Analytical storage specific properties.", + "type": "object", + "$ref": "#/definitions/AnalyticalStorageConfiguration" + }, + "instanceId": { + "description": "A unique identifier assigned to the database account", + "type": "string", + "readOnly": true + }, + "createMode": { + "description": "Enum to indicate the mode of account creation.", + "type": "string", + "default": "Default", + "$ref": "#/definitions/CreateMode" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore.", + "type": "object", + "$ref": "#/definitions/RestoreParameters" + }, + "backupPolicy": { + "description": "The object representing the policy for taking backups on an account.", + "type": "object", + "$ref": "#/definitions/BackupPolicy" + }, + "cors": { + "type": "array", + "description": "The CORS policy for the Cosmos DB database account.", + "items": { + "$ref": "#/definitions/CorsPolicy" + } + }, + "networkAclBypass": { + "description": "Indicates what services are allowed to bypass firewall checks.", + "$ref": "#/definitions/NetworkAclBypass" + }, + "networkAclBypassResourceIds": { + "type": "array", + "description": "An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.", + "items": { + "type": "string", + "format": "arm-id" + } + }, + "disableLocalAuth": { + "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.", + "type": "boolean" + }, + "capacity": { + "description": "The object that represents all properties related to capacity enforcement on an account.", + "type": "object", + "$ref": "#/definitions/Capacity" + }, + "keysMetadata": { + "description": "The object that represents the metadata for the Account Keys of the Cosmos DB account.", + "type": "object", + "$ref": "#/definitions/DatabaseAccountKeysMetadata" + }, + "enablePartitionMerge": { + "description": "Flag to indicate enabling/disabling of Partition Merge feature on the account", + "type": "boolean" + }, + "minimalTlsVersion": { + "description": "Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.", + "type": "string", + "$ref": "#/definitions/MinimalTlsVersion" + }, + "enableBurstCapacity": { + "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "type": "boolean" + }, + "customerManagedKeyStatus": { + "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.", + "type": "string" + } + } + }, + "DatabaseAccountCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB database accounts.", + "type": "object", + "properties": { + "consistencyPolicy": { + "description": "The consistency policy for the Cosmos DB account.", + "$ref": "#/definitions/ConsistencyPolicy" + }, + "locations": { + "type": "array", + "description": "An array that contains the georeplication locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "databaseAccountOfferType": { + "description": "The offer type for the database", + "$ref": "#/definitions/DatabaseAccountOfferType" + }, + "ipRules": { + "description": "List of IpRules.", + "$ref": "#/definitions/IPRules" + }, + "isVirtualNetworkFilterEnabled": { + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.", + "type": "boolean" + }, + "enableAutomaticFailover": { + "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.", + "type": "boolean" + }, + "capabilities": { + "type": "array", + "description": "List of Cosmos DB capabilities for the account", + "items": { + "$ref": "#/definitions/Capability" + } + }, + "virtualNetworkRules": { + "type": "array", + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "enableMultipleWriteLocations": { + "description": "Enables the account to write in multiple locations", + "type": "boolean" + }, + "enableCassandraConnector": { + "description": "Enables the cassandra connector on the Cosmos DB C* account", + "type": "boolean" + }, + "connectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB database C* account.", + "$ref": "#/definitions/ConnectorOffer" + }, + "disableKeyBasedMetadataWriteAccess": { + "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys", + "type": "boolean" + }, + "keyVaultKeyUri": { + "description": "The URI of the key vault", + "type": "string" + }, + "defaultIdentity": { + "description": "The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be \"FirstPartyIdentity\", \"SystemAssignedIdentity\" and more.", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "enableFreeTier": { + "description": "Flag to indicate whether Free Tier is enabled.", + "type": "boolean" + }, + "apiProperties": { + "description": "API specific properties. Currently, supported only for MongoDB API.", + "type": "object", + "$ref": "#/definitions/ApiProperties" + }, + "enableAnalyticalStorage": { + "description": "Flag to indicate whether to enable storage analytics.", + "type": "boolean" + }, + "analyticalStorageConfiguration": { + "description": "Analytical storage specific properties.", + "type": "object", + "$ref": "#/definitions/AnalyticalStorageConfiguration" + }, + "createMode": { + "description": "Enum to indicate the mode of account creation.", + "type": "string", + "default": "Default", + "$ref": "#/definitions/CreateMode" + }, + "backupPolicy": { + "description": "The object representing the policy for taking backups on an account.", + "type": "object", + "$ref": "#/definitions/BackupPolicy" + }, + "cors": { + "type": "array", + "description": "The CORS policy for the Cosmos DB database account.", + "items": { + "$ref": "#/definitions/CorsPolicy" + } + }, + "networkAclBypass": { + "description": "Indicates what services are allowed to bypass firewall checks.", + "$ref": "#/definitions/NetworkAclBypass" + }, + "networkAclBypassResourceIds": { + "type": "array", + "description": "An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.", + "items": { + "type": "string" + } + }, + "disableLocalAuth": { + "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.", + "type": "boolean" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore.", + "type": "object", + "$ref": "#/definitions/RestoreParameters" + }, + "capacity": { + "description": "The object that represents all properties related to capacity enforcement on an account.", + "type": "object", + "$ref": "#/definitions/Capacity" + }, + "keysMetadata": { + "description": "This property is ignored during the update/create operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account.", + "type": "object", + "$ref": "#/definitions/DatabaseAccountKeysMetadata" + }, + "enablePartitionMerge": { + "description": "Flag to indicate enabling/disabling of Partition Merge feature on the account", + "type": "boolean" + }, + "minimalTlsVersion": { + "description": "Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.", + "type": "string", + "$ref": "#/definitions/MinimalTlsVersion" + }, + "enableBurstCapacity": { + "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "type": "boolean" + }, + "customerManagedKeyStatus": { + "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.", + "type": "string" + } + }, + "required": [ + "locations", + "databaseAccountOfferType" + ] + }, + "DatabaseAccountCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB database accounts.", + "type": "object", + "properties": { + "kind": { + "description": "Indicates the type of database account. This can only be set at database account creation.", + "type": "string", + "default": "GlobalDocumentDB", + "enum": [ + "GlobalDocumentDB", + "MongoDB", + "Parse" + ], + "x-ms-enum": { + "name": "DatabaseAccountKind", + "modelAsString": true + } + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseAccountCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "DatabaseAccountUpdateProperties": { + "description": "Properties to update Azure Cosmos DB database accounts.", + "type": "object", + "properties": { + "consistencyPolicy": { + "description": "The consistency policy for the Cosmos DB account.", + "$ref": "#/definitions/ConsistencyPolicy" + }, + "locations": { + "type": "array", + "description": "An array that contains the georeplication locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "ipRules": { + "description": "List of IpRules.", + "$ref": "#/definitions/IPRules" + }, + "isVirtualNetworkFilterEnabled": { + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.", + "type": "boolean" + }, + "enableAutomaticFailover": { + "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.", + "type": "boolean" + }, + "capabilities": { + "type": "array", + "description": "List of Cosmos DB capabilities for the account", + "items": { + "$ref": "#/definitions/Capability" + } + }, + "virtualNetworkRules": { + "type": "array", + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "enableMultipleWriteLocations": { + "description": "Enables the account to write in multiple locations", + "type": "boolean" + }, + "enableCassandraConnector": { + "description": "Enables the cassandra connector on the Cosmos DB C* account", + "type": "boolean" + }, + "connectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB database C* account.", + "$ref": "#/definitions/ConnectorOffer" + }, + "disableKeyBasedMetadataWriteAccess": { + "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys", + "type": "boolean" + }, + "keyVaultKeyUri": { + "description": "The URI of the key vault", + "type": "string" + }, + "defaultIdentity": { + "description": "The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be \"FirstPartyIdentity\", \"SystemAssignedIdentity\" and more.", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "enableFreeTier": { + "description": "Flag to indicate whether Free Tier is enabled.", + "type": "boolean" + }, + "apiProperties": { + "description": "API specific properties. Currently, supported only for MongoDB API.", + "type": "object", + "$ref": "#/definitions/ApiProperties" + }, + "enableAnalyticalStorage": { + "description": "Flag to indicate whether to enable storage analytics.", + "type": "boolean" + }, + "analyticalStorageConfiguration": { + "description": "Analytical storage specific properties.", + "type": "object", + "$ref": "#/definitions/AnalyticalStorageConfiguration" + }, + "backupPolicy": { + "description": "The object representing the policy for taking backups on an account.", + "type": "object", + "$ref": "#/definitions/BackupPolicy" + }, + "cors": { + "type": "array", + "description": "The CORS policy for the Cosmos DB database account.", + "items": { + "$ref": "#/definitions/CorsPolicy" + } + }, + "networkAclBypass": { + "description": "Indicates what services are allowed to bypass firewall checks.", + "$ref": "#/definitions/NetworkAclBypass" + }, + "networkAclBypassResourceIds": { + "type": "array", + "description": "An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.", + "items": { + "type": "string" + } + }, + "disableLocalAuth": { + "description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.", + "type": "boolean" + }, + "capacity": { + "description": "The object that represents all properties related to capacity enforcement on an account.", + "type": "object", + "$ref": "#/definitions/Capacity" + }, + "keysMetadata": { + "description": "This property is ignored during the update operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account.", + "type": "object", + "$ref": "#/definitions/DatabaseAccountKeysMetadata" + }, + "enablePartitionMerge": { + "description": "Flag to indicate enabling/disabling of Partition Merge feature on the account", + "type": "boolean" + }, + "minimalTlsVersion": { + "description": "Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.", + "type": "string", + "$ref": "#/definitions/MinimalTlsVersion" + }, + "enableBurstCapacity": { + "description": "Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account", + "type": "boolean" + }, + "customerManagedKeyStatus": { + "description": "Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.", + "type": "string" + } + } + }, + "DatabaseAccountUpdateParameters": { + "description": "Parameters for patching Azure Cosmos DB database account properties.", + "type": "object", + "properties": { + "tags": { + "$ref": "#/definitions/Tags" + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseAccountUpdateProperties" + } + } + }, + "DatabaseAccountListReadOnlyKeysResult": { + "description": "The read-only access keys for the given database account.", + "properties": { + "primaryReadonlyMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the primary read-only key." + }, + "secondaryReadonlyMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the secondary read-only key." + } + } + }, + "DatabaseAccountListKeysResult": { + "description": "The access keys for the given database account.", + "properties": { + "primaryMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the primary read-write key." + }, + "secondaryMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the secondary read-write key." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DatabaseAccountListReadOnlyKeysResult" + } + ] + }, + "DatabaseAccountConnectionString": { + "description": "Connection string for the Cosmos DB account", + "properties": { + "connectionString": { + "readOnly": true, + "type": "string", + "description": "Value of the connection string" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the connection string" + }, + "keyKind": { + "readOnly": true, + "type": "string", + "description": "Kind of the connection string key", + "enum": [ + "Primary", + "Secondary", + "PrimaryReadonly", + "SecondaryReadonly" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the connection string", + "enum": [ + "Sql", + "Table", + "MongoDB", + "Cassandra", + "CassandraConnectorMetadata", + "Gremlin", + "SqlDedicatedGateway", + "GremlinV2", + "Undefined" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + } + } + }, + "DatabaseAccountListConnectionStringsResult": { + "description": "The connection strings for the given database account.", + "properties": { + "connectionStrings": { + "type": "array", + "description": "An array that contains the connection strings for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/DatabaseAccountConnectionString" + } + } + } + }, + "DatabaseAccountRegenerateKeyParameters": { + "type": "object", + "description": "Parameters to regenerate the keys within the database account.", + "properties": { + "keyKind": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "primary", + "secondary", + "primaryReadonly", + "secondaryReadonly" + ], + "x-ms-enum": { + "name": "KeyKind", + "modelAsString": true + } + } + }, + "required": [ + "keyKind" + ] + }, + "DatabaseAccountOfferType": { + "description": "The offer type for the Cosmos DB database account.", + "type": "string", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "DatabaseAccountOfferType", + "modelAsString": false + } + }, + "ThroughputSettingsUpdateParameters": { + "description": "Parameters to update Cosmos DB resource throughput.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to update Azure Cosmos DB resource throughput.", + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "ThroughputSettingsUpdateProperties": { + "description": "Properties to update Azure Cosmos DB resource throughput.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a resource throughput", + "$ref": "#/definitions/ThroughputSettingsResource" + } + }, + "required": [ + "resource" + ] + }, + "SqlDatabaseCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB SQL database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB SQL database.", + "$ref": "#/definitions/SqlDatabaseCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlDatabaseCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB SQL database.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a SQL database", + "$ref": "#/definitions/SqlDatabaseResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "SqlContainerCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB container.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB container.", + "$ref": "#/definitions/SqlContainerCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlContainerCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB container.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a container", + "$ref": "#/definitions/SqlContainerResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "SqlStoredProcedureCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB storedProcedure.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB storedProcedure.", + "$ref": "#/definitions/SqlStoredProcedureCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlStoredProcedureCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB storedProcedure.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a storedProcedure", + "$ref": "#/definitions/SqlStoredProcedureResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "SqlUserDefinedFunctionCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB userDefinedFunction.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB userDefinedFunction.", + "$ref": "#/definitions/SqlUserDefinedFunctionCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlUserDefinedFunctionCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB userDefinedFunction.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a userDefinedFunction", + "$ref": "#/definitions/SqlUserDefinedFunctionResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "SqlTriggerCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB trigger.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB trigger.", + "$ref": "#/definitions/SqlTriggerCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlTriggerCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB trigger.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a trigger", + "$ref": "#/definitions/SqlTriggerResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "MongoDBDatabaseCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB MongoDB database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB MongoDB database.", + "$ref": "#/definitions/MongoDBDatabaseCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "MongoDBDatabaseCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB MongoDB database.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a MongoDB database", + "$ref": "#/definitions/MongoDBDatabaseResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "MongoDBCollectionCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB MongoDB collection.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB MongoDB collection.", + "$ref": "#/definitions/MongoDBCollectionCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "MongoDBCollectionCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB MongoDB collection.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a MongoDB collection", + "$ref": "#/definitions/MongoDBCollectionResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "TableCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Table.", + "$ref": "#/definitions/TableCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "TableCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Table.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Table", + "$ref": "#/definitions/TableResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "CassandraKeyspaceCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Cassandra keyspace.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace.", + "$ref": "#/definitions/CassandraKeyspaceCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "CassandraKeyspaceCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Cassandra keyspace", + "$ref": "#/definitions/CassandraKeyspaceResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "CassandraTableCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Cassandra table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Cassandra table.", + "$ref": "#/definitions/CassandraTableCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "CassandraTableCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Cassandra table.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Cassandra table", + "$ref": "#/definitions/CassandraTableResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "GremlinDatabaseCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Gremlin database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Gremlin database.", + "$ref": "#/definitions/GremlinDatabaseCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "GremlinDatabaseCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Gremlin database.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Gremlin database", + "$ref": "#/definitions/GremlinDatabaseResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "GremlinGraphCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Gremlin graph.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Gremlin graph.", + "$ref": "#/definitions/GremlinGraphCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "GremlinGraphCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Gremlin graph.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Gremlin graph", + "$ref": "#/definitions/GremlinGraphResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource" + ] + }, + "ThroughputSettingsResource": { + "type": "object", + "description": "Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.", + "properties": { + "throughput": { + "type": "integer", + "description": "Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both." + }, + "autoscaleSettings": { + "description": "Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.", + "$ref": "#/definitions/AutoscaleSettingsResource" + }, + "minimumThroughput": { + "type": "string", + "description": "The minimum throughput of the resource", + "readOnly": true + }, + "offerReplacePending": { + "type": "string", + "description": "The throughput replace is pending", + "readOnly": true + }, + "instantMaximumThroughput": { + "type": "string", + "description": "The offer throughput value to instantly scale up without triggering splits", + "readOnly": true + }, + "softAllowedMaximumThroughput": { + "type": "string", + "description": "The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified", + "readOnly": true + } + } + }, + "AutoscaleSettingsResource": { + "type": "object", + "description": "Cosmos DB provisioned throughput settings object", + "properties": { + "maxThroughput": { + "type": "integer", + "description": "Represents maximum throughput container can scale up to." + }, + "autoUpgradePolicy": { + "description": "Cosmos DB resource auto-upgrade policy", + "$ref": "#/definitions/AutoUpgradePolicyResource" + }, + "targetMaxThroughput": { + "type": "integer", + "description": "Represents target maximum throughput container can scale up to once offer is no longer in pending state.", + "readOnly": true + } + }, + "required": [ + "maxThroughput" + ] + }, + "AutoUpgradePolicyResource": { + "type": "object", + "description": "Cosmos DB resource auto-upgrade policy", + "properties": { + "throughputPolicy": { + "description": "Represents throughput policy which service must adhere to for auto-upgrade", + "$ref": "#/definitions/ThroughputPolicyResource" + } + } + }, + "ThroughputPolicyResource": { + "type": "object", + "description": "Cosmos DB resource throughput policy", + "properties": { + "isEnabled": { + "type": "boolean", + "description": "Determines whether the ThroughputPolicy is active or not" + }, + "incrementPercent": { + "type": "integer", + "description": "Represents the percentage by which throughput can increase every time throughput policy kicks in." + } + } + }, + "OptionsResource": { + "type": "object", + "description": "Cosmos DB options resource object", + "readOnly": true, + "properties": { + "throughput": { + "type": "integer", + "description": "Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details." + }, + "autoscaleSettings": { + "type": "object", + "$ref": "#/definitions/AutoscaleSettings", + "description": "Specifies the Autoscale settings." + } + } + }, + "ClientEncryptionKeyResource": { + "type": "object", + "description": "Cosmos DB client encryption key resource object.", + "properties": { + "id": { + "type": "string", + "description": "Name of the ClientEncryptionKey" + }, + "encryptionAlgorithm": { + "type": "string", + "description": "Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data." + }, + "wrappedDataEncryptionKey": { + "type": "string", + "format": "byte", + "description": "Wrapped (encrypted) form of the key represented as a byte array." + }, + "keyWrapMetadata": { + "description": "Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.", + "$ref": "#/definitions/KeyWrapMetadata" + } + } + }, + "KeyWrapMetadata": { + "type": "object", + "description": "Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key.", + "properties": { + "name": { + "type": "string", + "description": "The name of associated KeyEncryptionKey (aka CustomerManagedKey)." + }, + "type": { + "type": "string", + "description": "ProviderName of KeyStoreProvider." + }, + "value": { + "type": "string", + "description": "Reference / link to the KeyEncryptionKey." + }, + "algorithm": { + "type": "string", + "description": "Algorithm used in wrapping and unwrapping of the data encryption key." + } + } + }, + "SqlDatabaseResource": { + "type": "object", + "description": "Cosmos DB SQL database resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL database" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "SqlContainerResource": { + "type": "object", + "description": "Cosmos DB SQL container resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL container" + }, + "indexingPolicy": { + "$ref": "#/definitions/IndexingPolicy", + "description": "The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container" + }, + "partitionKey": { + "$ref": "#/definitions/ContainerPartitionKey", + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "defaultTtl": { + "type": "integer", + "description": "Default time to live" + }, + "uniqueKeyPolicy": { + "$ref": "#/definitions/UniqueKeyPolicy", + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "conflictResolutionPolicy": { + "$ref": "#/definitions/ConflictResolutionPolicy", + "description": "The conflict resolution policy for the container." + }, + "clientEncryptionPolicy": { + "$ref": "#/definitions/ClientEncryptionPolicy", + "description": "The client encryption policy for the container." + }, + "analyticalStorageTtl": { + "type": "integer", + "format": "int64", + "description": "Analytical TTL." + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + }, + "computedProperties": { + "description": "List of computed properties", + "type": "array", + "items": { + "$ref": "#/definitions/ComputedProperty" + } + } + }, + "required": [ + "id" + ] + }, + "IndexingPolicy": { + "type": "object", + "description": "Cosmos DB indexing policy", + "properties": { + "automatic": { + "type": "boolean", + "description": "Indicates if the indexing policy is automatic" + }, + "indexingMode": { + "description": "Indicates the indexing mode.", + "type": "string", + "default": "consistent", + "enum": [ + "consistent", + "lazy", + "none" + ], + "x-ms-enum": { + "name": "IndexingMode", + "modelAsString": true + } + }, + "includedPaths": { + "description": "List of paths to include in the indexing", + "type": "array", + "items": { + "$ref": "#/definitions/IncludedPath" + } + }, + "excludedPaths": { + "description": "List of paths to exclude from indexing", + "type": "array", + "items": { + "$ref": "#/definitions/ExcludedPath" + } + }, + "compositeIndexes": { + "description": "List of composite path list", + "type": "array", + "items": { + "$ref": "#/definitions/CompositePathList" + } + }, + "spatialIndexes": { + "description": "List of spatial specifics", + "type": "array", + "items": { + "$ref": "#/definitions/SpatialSpec" + } + } + } + }, + "ExcludedPath": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + } + } + }, + "IncludedPath": { + "type": "object", + "description": "The paths that are included in indexing", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "indexes": { + "description": "List of indexes for this path", + "type": "array", + "items": { + "$ref": "#/definitions/Indexes" + } + } + } + }, + "Indexes": { + "type": "object", + "description": "The indexes for the path.", + "properties": { + "dataType": { + "description": "The datatype for which the indexing behavior is applied to.", + "type": "string", + "default": "String", + "enum": [ + "String", + "Number", + "Point", + "Polygon", + "LineString", + "MultiPolygon" + ], + "x-ms-enum": { + "name": "DataType", + "modelAsString": true + } + }, + "precision": { + "description": "The precision of the index. -1 is maximum precision.", + "type": "integer" + }, + "kind": { + "description": "Indicates the type of index.", + "type": "string", + "default": "Hash", + "enum": [ + "Hash", + "Range", + "Spatial" + ], + "x-ms-enum": { + "name": "IndexKind", + "modelAsString": true + } + } + } + }, + "CompositePathList": { + "description": "List of composite path", + "type": "array", + "items": { + "$ref": "#/definitions/CompositePath" + } + }, + "CompositePath": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "order": { + "description": "Sort order for composite paths.", + "type": "string", + "enum": [ + "ascending", + "descending" + ], + "x-ms-enum": { + "name": "CompositePathSortOrder", + "modelAsString": true + } + } + } + }, + "SpatialSpec": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "types": { + "description": "List of path's spatial type", + "type": "array", + "items": { + "$ref": "#/definitions/SpatialType" + } + } + } + }, + "SpatialType": { + "description": "Indicates the spatial type of index.", + "type": "string", + "enum": [ + "Point", + "LineString", + "Polygon", + "MultiPolygon" + ], + "x-ms-enum": { + "name": "SpatialType", + "modelAsString": true + } + }, + "ComputedProperty": { + "type": "object", + "description": "The definition of a computed property", + "properties": { + "name": { + "type": "string", + "description": "The name of a computed property, for example - \"cp_lowerName\"" + }, + "query": { + "type": "string", + "description": "The query that evaluates the value for computed property, for example - \"SELECT VALUE LOWER(c.name) FROM c\"" + } + } + }, + "ContainerPartitionKey": { + "type": "object", + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions", + "properties": { + "paths": { + "description": "List of paths using which data within the container can be partitioned", + "type": "array", + "items": { + "$ref": "#/definitions/Path" + } + }, + "kind": { + "description": "Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create", + "type": "string", + "default": "Hash", + "enum": [ + "Hash", + "Range", + "MultiHash" + ], + "x-ms-enum": { + "name": "PartitionKind", + "modelAsString": true + } + }, + "version": { + "description": "Indicates the version of the partition key definition", + "type": "integer", + "minimum": 1, + "maximum": 2, + "format": "int32" + }, + "systemKey": { + "description": "Indicates if the container is using a system generated partition key", + "type": "boolean", + "readOnly": true + } + } + }, + "Path": { + "type": "string", + "description": "A path. These typically start with root (/path)" + }, + "UniqueKeyPolicy": { + "type": "object", + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.", + "properties": { + "uniqueKeys": { + "description": "List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.", + "type": "array", + "items": { + "$ref": "#/definitions/UniqueKey" + } + } + } + }, + "UniqueKey": { + "type": "object", + "description": "The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.", + "properties": { + "paths": { + "description": "List of paths must be unique for each document in the Azure Cosmos DB service", + "type": "array", + "items": { + "$ref": "#/definitions/Path" + } + } + } + }, + "ConflictResolutionPolicy": { + "type": "object", + "description": "The conflict resolution policy for the container.", + "properties": { + "mode": { + "description": "Indicates the conflict resolution mode.", + "type": "string", + "default": "LastWriterWins", + "enum": [ + "LastWriterWins", + "Custom" + ], + "x-ms-enum": { + "name": "ConflictResolutionMode", + "modelAsString": true + } + }, + "conflictResolutionPath": { + "type": "string", + "description": "The conflict resolution path in the case of LastWriterWins mode." + }, + "conflictResolutionProcedure": { + "type": "string", + "description": "The procedure to resolve conflicts in the case of custom mode." + } + } + }, + "ClientEncryptionPolicy": { + "type": "object", + "description": "Cosmos DB client encryption policy.", + "properties": { + "includedPaths": { + "description": "Paths of the item that need encryption along with path-specific settings.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientEncryptionIncludedPath" + }, + "x-ms-identifiers": [] + }, + "policyFormatVersion": { + "description": "Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption. ", + "type": "integer", + "minimum": 1, + "maximum": 2, + "format": "int32" + } + }, + "required": [ + "includedPaths", + "policyFormatVersion" + ] + }, + "ClientEncryptionIncludedPath": { + "type": "object", + "description": ".", + "properties": { + "path": { + "description": "Path that needs to be encrypted.", + "type": "string" + }, + "clientEncryptionKeyId": { + "description": "The identifier of the Client Encryption Key to be used to encrypt the path.", + "type": "string" + }, + "encryptionType": { + "description": "The type of encryption to be performed. Eg - Deterministic, Randomized.", + "type": "string" + }, + "encryptionAlgorithm": { + "description": "The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.", + "type": "string" + } + }, + "required": [ + "path", + "clientEncryptionKeyId", + "encryptionType", + "encryptionAlgorithm" + ] + }, + "SqlStoredProcedureResource": { + "type": "object", + "description": "Cosmos DB SQL storedProcedure resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL storedProcedure" + }, + "body": { + "type": "string", + "description": "Body of the Stored Procedure" + } + }, + "required": [ + "id" + ] + }, + "SqlUserDefinedFunctionResource": { + "type": "object", + "description": "Cosmos DB SQL userDefinedFunction resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL userDefinedFunction" + }, + "body": { + "type": "string", + "description": "Body of the User Defined Function" + } + }, + "required": [ + "id" + ] + }, + "SqlTriggerResource": { + "type": "object", + "description": "Cosmos DB SQL trigger resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL trigger" + }, + "body": { + "type": "string", + "description": "Body of the Trigger" + }, + "triggerType": { + "type": "string", + "enum": [ + "Pre", + "Post" + ], + "description": "Type of the Trigger", + "x-ms-enum": { + "name": "triggerType", + "modelAsString": true + } + }, + "triggerOperation": { + "type": "string", + "enum": [ + "All", + "Create", + "Update", + "Delete", + "Replace" + ], + "description": "The operation the trigger is associated with", + "x-ms-enum": { + "name": "triggerOperation", + "modelAsString": true + } + } + }, + "required": [ + "id" + ] + }, + "MongoDBDatabaseResource": { + "type": "object", + "description": "Cosmos DB MongoDB database resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB MongoDB database" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "MongoDBCollectionResource": { + "type": "object", + "description": "Cosmos DB MongoDB collection resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB MongoDB collection" + }, + "shardKey": { + "description": "A key-value pair of shard keys to be applied for the request.", + "$ref": "#/definitions/ShardKeys" + }, + "indexes": { + "description": "List of index keys", + "type": "array", + "items": { + "$ref": "#/definitions/MongoIndex" + } + }, + "analyticalStorageTtl": { + "type": "integer", + "description": "Analytical TTL." + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "ShardKeys": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The shard key and partition kind pair, only support \"Hash\" partition kind" + }, + "MongoIndex": { + "type": "object", + "description": "Cosmos DB MongoDB collection index key", + "properties": { + "key": { + "description": "Cosmos DB MongoDB collection index keys", + "$ref": "#/definitions/MongoIndexKeys" + }, + "options": { + "description": "Cosmos DB MongoDB collection index key options", + "$ref": "#/definitions/MongoIndexOptions" + } + } + }, + "MongoIndexKeys": { + "type": "object", + "description": "Cosmos DB MongoDB collection resource object", + "properties": { + "keys": { + "description": "List of keys for each MongoDB collection in the Azure Cosmos DB service", + "type": "array", + "items": { + "$ref": "#/definitions/Key" + } + } + } + }, + "Key": { + "type": "string", + "description": "A Key." + }, + "MongoIndexOptions": { + "type": "object", + "description": "Cosmos DB MongoDB collection index options", + "properties": { + "expireAfterSeconds": { + "description": "Expire after seconds", + "type": "integer" + }, + "unique": { + "description": "Is unique or not", + "type": "boolean" + } + } + }, + "TableResource": { + "type": "object", + "description": "Cosmos DB table resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB table" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "CassandraKeyspaceResource": { + "type": "object", + "description": "Cosmos DB Cassandra keyspace resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra keyspace" + } + }, + "required": [ + "id" + ] + }, + "CassandraTableResource": { + "type": "object", + "description": "Cosmos DB Cassandra table resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table" + }, + "defaultTtl": { + "type": "integer", + "description": "Time to live of the Cosmos DB Cassandra table" + }, + "schema": { + "description": "Schema of the Cosmos DB Cassandra table", + "$ref": "#/definitions/CassandraSchema" + }, + "analyticalStorageTtl": { + "type": "integer", + "description": "Analytical TTL." + } + }, + "required": [ + "id" + ] + }, + "CassandraSchema": { + "type": "object", + "description": "Cosmos DB Cassandra table schema", + "properties": { + "columns": { + "type": "array", + "items": { + "$ref": "#/definitions/Column" + }, + "description": "List of Cassandra table columns." + }, + "partitionKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/CassandraPartitionKey" + }, + "description": "List of partition key." + }, + "clusterKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ClusterKey" + }, + "description": "List of cluster key." + } + } + }, + "Column": { + "type": "object", + "description": "Cosmos DB Cassandra table column", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table column" + }, + "type": { + "type": "string", + "description": "Type of the Cosmos DB Cassandra table column" + } + } + }, + "CassandraPartitionKey": { + "type": "object", + "description": "Cosmos DB Cassandra table partition key", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table partition key" + } + } + }, + "ClusterKey": { + "type": "object", + "description": "Cosmos DB Cassandra table cluster key", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table cluster key" + }, + "orderBy": { + "type": "string", + "description": "Order of the Cosmos DB Cassandra table cluster key, only support \"Asc\" and \"Desc\"" + } + } + }, + "GremlinDatabaseResource": { + "type": "object", + "description": "Cosmos DB Gremlin database resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Gremlin database" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "GremlinGraphResource": { + "type": "object", + "description": "Cosmos DB Gremlin graph resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Gremlin graph" + }, + "indexingPolicy": { + "$ref": "#/definitions/IndexingPolicy", + "description": "The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph" + }, + "partitionKey": { + "$ref": "#/definitions/ContainerPartitionKey", + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "defaultTtl": { + "type": "integer", + "description": "Default time to live" + }, + "uniqueKeyPolicy": { + "$ref": "#/definitions/UniqueKeyPolicy", + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "conflictResolutionPolicy": { + "$ref": "#/definitions/ConflictResolutionPolicy", + "description": "The conflict resolution policy for the graph." + }, + "analyticalStorageTtl": { + "type": "integer", + "format": "int64", + "description": "Analytical TTL." + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore", + "$ref": "#/definitions/ResourceRestoreParameters" + }, + "createMode": { + "description": "Enum to indicate the mode of resource creation.", + "$ref": "#/definitions/CreateMode" + } + }, + "required": [ + "id" + ] + }, + "CreateUpdateOptions": { + "type": "object", + "properties": { + "throughput": { + "type": "integer", + "description": "Request Units per second. For example, \"throughput\": 10000." + }, + "autoscaleSettings": { + "$ref": "#/definitions/AutoscaleSettings", + "description": "Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both." + } + }, + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + }, + "AutoscaleSettings": { + "type": "object", + "properties": { + "maxThroughput": { + "type": "integer", + "description": "Represents maximum throughput, the resource can scale up to." + } + } + }, + "Capability": { + "type": "object", + "description": "Cosmos DB capability object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB capability. For example, \"name\": \"EnableCassandra\". Current values also include \"EnableTable\" and \"EnableGremlin\"." + } + } + }, + "Capacity": { + "type": "object", + "description": "The object that represents all properties related to capacity enforcement on an account.", + "properties": { + "totalThroughputLimit": { + "type": "integer", + "minimum": -1, + "format": "int32", + "description": "The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput." + } + } + }, + "Tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "ManagedServiceIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the resource." + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed." + }, + "IPRules": { + "type": "array", + "description": "Array of IpAddressOrRange objects.", + "items": { + "$ref": "#/definitions/IpAddressOrRange" + } + }, + "IpAddressOrRange": { + "type": "object", + "description": "IpAddressOrRange object", + "properties": { + "ipAddressOrRange": { + "type": "string", + "description": "A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”." + } + } + }, + "VirtualNetworkRule": { + "type": "object", + "description": "Virtual Network ACL Rule object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}." + }, + "ignoreMissingVNetServiceEndpoint": { + "type": "boolean", + "description": "Create firewall rule before the virtual network has vnet service endpoint enabled." + } + } + }, + "NetworkAclBypass": { + "description": "Indicates what services are allowed to bypass firewall checks.", + "type": "string", + "enum": [ + "None", + "AzureServices" + ], + "x-ms-enum": { + "name": "NetworkAclBypass", + "modelAsString": false + } + }, + "AccountKeyMetadata": { + "description": "The metadata related to an access key for a given database account.", + "type": "object", + "properties": { + "generationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18." + } + } + }, + "DatabaseAccountKeysMetadata": { + "description": "The metadata related to each access key for the given Cosmos DB database account.", + "type": "object", + "readOnly": true, + "properties": { + "primaryMasterKey": { + "readOnly": true, + "description": "The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.", + "$ref": "#/definitions/AccountKeyMetadata" + }, + "secondaryMasterKey": { + "readOnly": true, + "description": "The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.", + "$ref": "#/definitions/AccountKeyMetadata" + }, + "primaryReadonlyMasterKey": { + "readOnly": true, + "description": "The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.", + "$ref": "#/definitions/AccountKeyMetadata" + }, + "secondaryReadonlyMasterKey": { + "readOnly": true, + "description": "The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.", + "$ref": "#/definitions/AccountKeyMetadata" + } + } + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "Provider": { + "description": "Service provider: Microsoft.ResourceProvider", + "type": "string" + }, + "Resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "type": "string" + }, + "Operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "Description": { + "description": "Description of operation", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the Resource Provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "UsagesResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of usages for the database. A usage is a point in time metric" + } + }, + "description": "The response to a list usage request." + }, + "Usage": { + "properties": { + "unit": { + "description": "The unit of the metric.", + "$ref": "#/definitions/UnitType" + }, + "name": { + "$ref": "#/definitions/MetricName", + "readOnly": true, + "description": "The name information for the metric." + }, + "quotaPeriod": { + "type": "string", + "readOnly": true, + "description": "The quota period used to summarize the usage values." + }, + "limit": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Maximum value for this metric" + }, + "currentValue": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Current value for this metric" + } + }, + "description": "The usage data for a usage request." + }, + "PartitionUsagesResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PartitionUsage" + }, + "description": "The list of partition-level usages for the database. A usage is a point in time metric" + } + }, + "description": "The response to a list partition level usage request." + }, + "PartitionUsage": { + "allOf": [ + { + "$ref": "#/definitions/Usage" + } + ], + "properties": { + "partitionId": { + "readOnly": true, + "type": "string", + "description": "The partition id (GUID identifier) of the usages." + }, + "partitionKeyRangeId": { + "readOnly": true, + "type": "string", + "description": "The partition key range id (integer identifier) of the usages." + } + }, + "description": "The partition level usage data for a usage request." + }, + "MetricDefinitionsListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MetricDefinition" + }, + "description": "The list of metric definitions for the account." + } + }, + "description": "The response to a list metric definitions request." + }, + "MetricDefinition": { + "properties": { + "metricAvailabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "description": "The list of metric availabilities for the account." + }, + "primaryAggregationType": { + "readOnly": true, + "type": "string", + "description": "The primary aggregation type of the metric.", + "enum": [ + "None", + "Average", + "Total", + "Minimum", + "Maximum", + "Last" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PrimaryAggregationType" + } + }, + "unit": { + "description": "The unit of the metric.", + "$ref": "#/definitions/UnitType" + }, + "resourceUri": { + "readOnly": true, + "type": "string", + "description": "The resource uri of the database." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + } + }, + "description": "The definition of a metric." + }, + "MetricAvailability": { + "properties": { + "timeGrain": { + "readOnly": true, + "type": "string", + "description": "The time grain to be used to summarize the metric values." + }, + "retention": { + "readOnly": true, + "type": "string", + "description": "The retention for the metric values." + } + }, + "description": "The availability of the metric." + }, + "MetricListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Metric" + }, + "description": "The list of metrics for the account." + } + }, + "description": "The response to a list metrics request." + }, + "Metric": { + "properties": { + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The start time for the metric (ISO-8601 format)." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The end time for the metric (ISO-8601 format)." + }, + "timeGrain": { + "readOnly": true, + "type": "string", + "description": "The time grain to be used to summarize the metric values." + }, + "unit": { + "$ref": "#/definitions/UnitType", + "description": "The unit of the metric." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + }, + "metricValues": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MetricValue" + }, + "description": "The metric values for the specified time window and timestep." + } + }, + "description": "Metric data" + }, + "MetricName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the metric." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The friendly name of the metric." + } + }, + "description": "A metric name." + }, + "MetricValue": { + "properties": { + "_count": { + "readOnly": true, + "type": "number", + "format": "int32", + "description": "The number of values for the metric." + }, + "average": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The average value of the metric." + }, + "maximum": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The max value of the metric." + }, + "minimum": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The min value of the metric." + }, + "timestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The metric timestamp (ISO-8601 format)." + }, + "total": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The total value of the metric." + } + }, + "description": "Represents metrics values." + }, + "PercentileMetricListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PercentileMetric" + }, + "description": "The list of percentile metrics for the account." + } + }, + "description": "The response to a list percentile metrics request." + }, + "PercentileMetric": { + "properties": { + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The start time for the metric (ISO-8601 format)." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The end time for the metric (ISO-8601 format)." + }, + "timeGrain": { + "readOnly": true, + "type": "string", + "description": "The time grain to be used to summarize the metric values." + }, + "unit": { + "$ref": "#/definitions/UnitType", + "description": "The unit of the metric." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + }, + "metricValues": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PercentileMetricValue" + }, + "description": "The percentile metric values for the specified time window and timestep." + } + }, + "description": "Percentile Metric data" + }, + "PercentileMetricValue": { + "allOf": [ + { + "$ref": "#/definitions/MetricValue" + } + ], + "properties": { + "P10": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 10th percentile value for the metric." + }, + "P25": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 25th percentile value for the metric." + }, + "P50": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 50th percentile value for the metric." + }, + "P75": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 75th percentile value for the metric." + }, + "P90": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 90th percentile value for the metric." + }, + "P95": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 95th percentile value for the metric." + }, + "P99": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 99th percentile value for the metric." + } + }, + "description": "Represents percentile metrics values." + }, + "PartitionMetricListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PartitionMetric" + }, + "description": "The list of partition-level metrics for the account." + } + }, + "description": "The response to a list partition metrics request." + }, + "PartitionMetric": { + "allOf": [ + { + "$ref": "#/definitions/Metric" + } + ], + "properties": { + "partitionId": { + "readOnly": true, + "type": "string", + "description": "The partition id (GUID identifier) of the metric values." + }, + "partitionKeyRangeId": { + "readOnly": true, + "type": "string", + "description": "The partition key range id (integer identifier) of the metric values." + } + }, + "description": "The metric values for a single partition." + }, + "UnitType": { + "type": "string", + "readOnly": true, + "description": "The unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond", + "Milliseconds" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "UnitType" + } + }, + "ConnectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB C* database account.", + "type": "string", + "enum": [ + "Small" + ], + "x-ms-enum": { + "name": "ConnectorOffer", + "modelAsString": true + } + }, + "PublicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "ApiProperties": { + "type": "object", + "properties": { + "serverVersion": { + "type": "string", + "enum": [ + "3.2", + "3.6", + "4.0", + "4.2" + ], + "description": "Describes the ServerVersion of an a MongoDB account.", + "x-ms-enum": { + "modelAsString": true, + "name": "ServerVersion" + } + } + } + }, + "AnalyticalStorageConfiguration": { + "type": "object", + "description": "Analytical storage specific properties.", + "properties": { + "schemaType": { + "type": "string", + "$ref": "#/definitions/AnalyticalStorageSchemaType" + } + } + }, + "AnalyticalStorageSchemaType": { + "type": "string", + "description": "Describes the types of schema for analytical storage.", + "enum": [ + "WellDefined", + "FullFidelity" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AnalyticalStorageSchemaType" + } + }, + "CreateMode": { + "description": "Enum to indicate the mode of account creation.", + "type": "string", + "default": "Default", + "enum": [ + "Default", + "Restore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + } + }, + "RestoreParameters": { + "type": "object", + "description": "Parameters to indicate the information about the restore.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "restoreMode": { + "type": "string", + "enum": [ + "PointInTime" + ], + "description": "Describes the mode of the restore.", + "x-ms-enum": { + "modelAsString": true, + "name": "RestoreMode" + } + }, + "databasesToRestore": { + "type": "array", + "description": "List of specific databases available for restore.", + "items": { + "$ref": "#/definitions/DatabaseRestoreResource" + } + }, + "gremlinDatabasesToRestore": { + "type": "array", + "description": "List of specific gremlin databases available for restore.", + "items": { + "$ref": "#/definitions/GremlinDatabaseRestoreResource" + } + }, + "tablesToRestore": { + "type": "array", + "description": "List of specific tables available for restore.", + "items": { + "$ref": "#/definitions/TableName" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/RestoreParametersBase" + } + ] + }, + "RestoreParametersBase": { + "type": "object", + "description": "Parameters to indicate the information about the restore.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "restoreSource": { + "type": "string", + "description": "The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}" + }, + "restoreTimestampInUtc": { + "type": "string", + "format": "date-time", + "description": "Time to which the account has to be restored (ISO-8601 format)." + } + } + }, + "ResourceRestoreParameters": { + "type": "object", + "description": "Parameters to indicate the information about the restore.", + "x-ms-mutability": [ + "read", + "create" + ], + "allOf": [ + { + "$ref": "#/definitions/RestoreParametersBase" + } + ] + }, + "DatabaseRestoreResource": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "databaseName": { + "type": "string", + "description": "The name of the database available for restore." + }, + "collectionNames": { + "type": "array", + "description": "The names of the collections available for restore.", + "items": { + "$ref": "#/definitions/CollectionName" + } + } + } + }, + "GremlinDatabaseRestoreResource": { + "type": "object", + "description": "Specific Gremlin Databases to restore.", + "properties": { + "databaseName": { + "type": "string", + "description": "The name of the gremlin database available for restore." + }, + "graphNames": { + "type": "array", + "description": "The names of the graphs available for restore.", + "items": { + "$ref": "#/definitions/GraphName" + } + } + } + }, + "CollectionName": { + "type": "string", + "description": "The name of the collection." + }, + "GraphName": { + "type": "string", + "description": "The name of the graph." + }, + "TableName": { + "type": "string", + "description": "The name of the table." + }, + "BackupPolicy": { + "type": "object", + "description": "The object representing the policy for taking backups on an account.", + "discriminator": "type", + "properties": { + "type": { + "description": "Describes the mode of backups.", + "type": "string", + "$ref": "#/definitions/BackupPolicyType" + }, + "migrationState": { + "description": "The object representing the state of the migration between the backup policies.", + "type": "object", + "$ref": "#/definitions/BackupPolicyMigrationState" + } + }, + "required": [ + "type" + ] + }, + "BackupPolicyType": { + "description": "Describes the mode of backups.", + "type": "string", + "enum": [ + "Periodic", + "Continuous" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BackupPolicyType" + } + }, + "BackupPolicyMigrationState": { + "type": "object", + "description": "The object representing the state of the migration between the backup policies.", + "properties": { + "status": { + "description": "Describes the status of migration between backup policy types.", + "type": "string", + "$ref": "#/definitions/BackupPolicyMigrationStatus" + }, + "targetType": { + "description": "Describes the target backup policy type of the backup policy migration.", + "type": "string", + "$ref": "#/definitions/BackupPolicyType" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Time at which the backup policy migration started (ISO-8601 format)." + } + } + }, + "BackupPolicyMigrationStatus": { + "description": "Describes the status of migration between backup policy types.", + "type": "string", + "enum": [ + "Invalid", + "InProgress", + "Completed", + "Failed" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BackupPolicyMigrationStatus" + } + }, + "PeriodicModeBackupPolicy": { + "description": "The object representing periodic mode backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupPolicy" + } + ], + "properties": { + "periodicModeProperties": { + "type": "object", + "description": "Configuration values for periodic mode backup", + "$ref": "#/definitions/PeriodicModeProperties" + } + }, + "x-ms-discriminator-value": "Periodic" + }, + "ContinuousModeBackupPolicy": { + "description": "The object representing continuous mode backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupPolicy" + } + ], + "properties": { + "continuousModeProperties": { + "type": "object", + "description": "Configuration values for continuous mode backup", + "$ref": "#/definitions/ContinuousModeProperties" + } + }, + "x-ms-discriminator-value": "Continuous" + }, + "PeriodicModeProperties": { + "type": "object", + "description": "Configuration values for periodic mode backup", + "properties": { + "backupIntervalInMinutes": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "An integer representing the interval in minutes between two backups" + }, + "backupRetentionIntervalInHours": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "An integer representing the time (in hours) that each backup is retained" + }, + "backupStorageRedundancy": { + "description": "Enum to indicate type of backup residency", + "type": "string", + "$ref": "#/definitions/BackupStorageRedundancy" + } + } + }, + "ContinuousModeProperties": { + "type": "object", + "description": "Configuration values for periodic mode backup", + "properties": { + "tier": { + "description": "Enum to indicate type of Continuous backup mode", + "type": "string", + "$ref": "#/definitions/ContinuousTier" + } + } + }, + "LocationListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/LocationGetResult" + }, + "description": "List of Cosmos DB locations and their properties." + } + }, + "description": "The List operation response, that contains Cosmos DB locations and their properties." + }, + "LocationGetResult": { + "description": "Cosmos DB location get result", + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "Cosmos DB location metadata", + "$ref": "#/definitions/LocationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMProxyResource" + } + ] + }, + "LocationProperties": { + "description": "Cosmos DB location metadata", + "type": "object", + "properties": { + "supportsAvailabilityZone": { + "type": "boolean", + "readOnly": true, + "description": "Flag indicating whether the location supports availability zones or not." + }, + "isResidencyRestricted": { + "type": "boolean", + "readOnly": true, + "description": "Flag indicating whether the location is residency sensitive." + }, + "backupStorageRedundancies": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/BackupStorageRedundancy" + }, + "description": "The properties of available backup storage redundancies." + }, + "isSubscriptionRegionAccessAllowedForRegular": { + "type": "boolean", + "readOnly": true, + "description": "Flag indicating whether the subscription have access in region for Non-Availability Zones." + }, + "isSubscriptionRegionAccessAllowedForAz": { + "type": "boolean", + "readOnly": true, + "description": "Flag indicating whether the subscription have access in region for Availability Zones(Az)." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Enum to indicate current buildout status of the region.", + "enum": [ + "Uninitialized", + "Initializing", + "InternallyReady", + "Online", + "Deleting" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + } + } + }, + "BackupStorageRedundancy": { + "description": "Enum to indicate type of backup storage redundancy.", + "type": "string", + "enum": [ + "Geo", + "Local", + "Zone" + ], + "x-ms-enum": { + "name": "BackupStorageRedundancy", + "modelAsString": true + } + }, + "ContinuousTier": { + "description": "Enum to indicate type of Continuous backup tier.", + "type": "string", + "enum": [ + "Continuous7Days", + "Continuous30Days" + ], + "x-ms-enum": { + "name": "ContinuousTier", + "modelAsString": true + } + }, + "MinimalTlsVersion": { + "description": "Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.", + "type": "string", + "enum": [ + "Tls", + "Tls11", + "Tls12" + ], + "x-ms-enum": { + "name": "MinimalTlsVersion", + "modelAsString": true + } + } + }, + "parameters": { + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of an Azure resource group." + }, + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq." + }, + "usageFilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names)." + }, + "databaseRidParameter": { + "name": "databaseRid", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database rid." + }, + "collectionRidParameter": { + "name": "collectionRid", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB collection rid." + }, + "databaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database name." + }, + "clientEncryptionKeyNameParameter": { + "name": "clientEncryptionKeyName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB ClientEncryptionKey name." + }, + "containerNameParameter": { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB container name." + }, + "storedProcedureNameParameter": { + "name": "storedProcedureName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB storedProcedure name." + }, + "userDefinedFunctionNameParameter": { + "name": "userDefinedFunctionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB userDefinedFunction name." + }, + "triggerNameParameter": { + "name": "triggerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB trigger name." + }, + "tableNameParameter": { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB table name." + }, + "collectionNameParameter": { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB collection name." + }, + "keyspaceNameParameter": { + "name": "keyspaceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB keyspace name." + }, + "graphNameParameter": { + "name": "graphName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB graph name." + }, + "regionParameter": { + "name": "region", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + }, + "sourceRegionParameter": { + "name": "sourceRegion", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized." + }, + "targetRegionParameter": { + "name": "targetRegion", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized." + }, + "partitionKeyRangeIdParameter": { + "name": "partitionKeyRangeId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Partition Key Range Id for which to get data." + }, + "locationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceCreateUpdate.json new file mode 100644 index 000000000000..ebf8532961b4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceCreateUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "createUpdateCassandraKeyspaceParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName", + "name": "keyspaceName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceDelete.json new file mode 100644 index 000000000000..7d4418d83d03 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceGet.json new file mode 100644 index 000000000000..e5e2e60f7da0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName", + "name": "keyspaceName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceList.json new file mode 100644 index 000000000000..f5a13e818714 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName", + "name": "keyspaceName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json new file mode 100644 index 000000000000..663e2cc099e6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json new file mode 100644 index 000000000000..7149a13d8fae --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceThroughputGet.json new file mode 100644 index 000000000000..5722ca8477fc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceThroughputGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json new file mode 100644 index 000000000000..f1a7f4866021 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableCreateUpdate.json new file mode 100644 index 000000000000..ec701fd57e6a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableCreateUpdate.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName", + "createUpdateCassandraTableParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableDelete.json new file mode 100644 index 000000000000..54d6ca23083c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableGet.json new file mode 100644 index 000000000000..dad537165bca --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableGet.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableList.json new file mode 100644 index 000000000000..502efeebf501 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableMigrateToAutoscale.json new file mode 100644 index 000000000000..da55c8ffde42 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableMigrateToAutoscale.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableMigrateToManualThroughput.json new file mode 100644 index 000000000000..b38e976def6c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableMigrateToManualThroughput.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableThroughputGet.json new file mode 100644 index 000000000000..4b24d75543d3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableThroughputGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableThroughputUpdate.json new file mode 100644 index 000000000000..cf1627bf814a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableThroughputUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables/throughputSettings", + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionGetMetricDefinitions.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionGetMetricDefinitions.json new file mode 100644 index 000000000000..7509176a3d9d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionGetMetricDefinitions.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "api-version": "2023-11-15", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "timeGrain": "PT5M", + "retention": "P2D" + }, + { + "timeGrain": "PT1H", + "retention": "P14D" + }, + { + "timeGrain": "P1D", + "retention": "P60D" + } + ], + "primaryAggregationType": "Total", + "unit": "Count", + "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionGetMetrics.json new file mode 100644 index 000000000000..c355014664e2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionGetMetrics.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionGetUsages.json new file mode 100644 index 000000000000..52c466502bb1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionGetUsages.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionPartitionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionPartitionGetMetrics.json new file mode 100644 index 000000000000..c57a1a4e8de7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionPartitionGetMetrics.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionPartitionGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionPartitionGetUsages.json new file mode 100644 index 000000000000..33a5b7db9002 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionPartitionGetUsages.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Partition Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionPartitionRegionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionPartitionRegionGetMetrics.json new file mode 100644 index 000000000000..a58a3b2c5a6c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCollectionPartitionRegionGetMetrics.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "region": "North Europe", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDataTransferServiceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDataTransferServiceCreate.json new file mode 100644 index 000000000000..5dbd5a982e24 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDataTransferServiceCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "DataTransfer", + "createUpdateParameters": { + "properties": { + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "DataTransfer" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/DataTransfer", + "name": "DataTransfer", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "DataTransfer", + "locations": [ + { + "name": "DataTransfer-westus2", + "location": "West US 2", + "status": "Running" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDataTransferServiceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDataTransferServiceDelete.json new file mode 100644 index 000000000000..34300035eeab --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDataTransferServiceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "DataTransfer" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDataTransferServiceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDataTransferServiceGet.json new file mode 100644 index 000000000000..0d8d2b2501e1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDataTransferServiceGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "DataTransfer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/DataTransfer", + "name": "DataTransfer", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "DataTransfer", + "locations": [ + { + "name": "DataTransfer-westus2", + "location": "West US 2", + "status": "Running" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCheckNameExists.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCheckNameExists.json new file mode 100644 index 000000000000..b484b8640f61 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCheckNameExists.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "accountName": "ddb1", + "api-version": "2023-11-15" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCreateMax.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCreateMax.json new file mode 100644 index 000000000000..d815d70185d0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCreateMax.json @@ -0,0 +1,240 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "createUpdateParameters": { + "location": "westus", + "tags": {}, + "kind": "MongoDB", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "databaseAccountOfferType": "Standard", + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "isVirtualNetworkFilterEnabled": true, + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false + } + ], + "publicNetworkAccess": "Enabled", + "locations": [ + { + "failoverPriority": 0, + "locationName": "southcentralus", + "isZoneRedundant": false + }, + { + "failoverPriority": 1, + "locationName": "eastus", + "isZoneRedundant": false + } + ], + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "keyVaultKeyUri": "https://myKeyVault.vault.azure.net", + "defaultIdentity": "FirstPartyIdentity", + "enableFreeTier": false, + "apiProperties": { + "serverVersion": "3.2" + }, + "enableAnalyticalStorage": true, + "enableBurstCapacity": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 8, + "backupStorageRedundancy": "Geo" + } + }, + "cors": [ + { + "allowedOrigins": "https://test" + } + ], + "networkAclBypass": "AzureServices", + "networkAclBypassResourceIds": [ + "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName" + ], + "capacity": { + "totalThroughputLimit": 2000 + }, + "minimalTlsVersion": "Tls12" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "MongoDB", + "tags": {}, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656", + "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d" + } + } + }, + "properties": { + "provisioningState": "Initializing", + "isVirtualNetworkFilterEnabled": true, + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "writeLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "readLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + }, + { + "id": "ddb1-eastus", + "locationName": "East US", + "provisioningState": "Initializing", + "failoverPriority": 1, + "isZoneRedundant": false + } + ], + "locations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + }, + { + "id": "ddb1-eastus", + "locationName": "East US", + "provisioningState": "Initializing", + "failoverPriority": 1, + "isZoneRedundant": false + } + ], + "failoverPolicies": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "failoverPriority": 0 + }, + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 1 + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + ], + "publicNetworkAccess": "Enabled", + "keyVaultKeyUri": "https://myKeyVault.vault.azure.net", + "defaultIdentity": "FirstPartyIdentity", + "enableFreeTier": false, + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "apiProperties": { + "serverVersion": "3.2" + }, + "enableAnalyticalStorage": true, + "enableBurstCapacity": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "createMode": "Default", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 8, + "backupStorageRedundancy": "Geo" + } + }, + "cors": [ + { + "allowedOrigins": "https://test" + } + ], + "networkAclBypass": "AzureServices", + "networkAclBypassResourceIds": [ + "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName" + ], + "capacity": { + "totalThroughputLimit": 2000 + }, + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2021-03-12T22:05:09Z" + }, + "secondaryMasterKey": { + "generationTime": "2021-03-12T22:05:09Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2021-03-12T22:05:09Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2021-03-12T22:05:09Z" + } + }, + "minimalTlsVersion": "Tls12" + }, + "systemData": { + "createdAt": "2021-03-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCreateMin.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCreateMin.json new file mode 100644 index 000000000000..cf0cfac3a670 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountCreateMin.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "createUpdateParameters": { + "location": "westus", + "properties": { + "databaseAccountOfferType": "Standard", + "createMode": "Default", + "locations": [ + { + "failoverPriority": 0, + "locationName": "southcentralus", + "isZoneRedundant": false + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Initializing", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "readLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "locations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "failoverPolicies": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "failoverPriority": 0 + } + ], + "cors": [], + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": false, + "analyticalStorageConfiguration": null, + "networkAclBypass": "None", + "networkAclBypassResourceIds": [], + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720, + "backupStorageRedundancy": "Geo" + } + }, + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2021-03-12T22:05:09Z" + }, + "secondaryMasterKey": { + "generationTime": "2021-03-12T22:05:09Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2021-03-12T22:05:09Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2021-03-12T22:05:09Z" + } + }, + "minimalTlsVersion": "Tls" + }, + "systemData": { + "createdAt": "2021-03-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountDelete.json new file mode 100644 index 000000000000..c5d3f056df5b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json new file mode 100644 index 000000000000..0938b9ae8af7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1-failover", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "failoverParameters": { + "failoverPolicies": [ + { + "locationName": "eastus", + "failoverPriority": 0 + }, + { + "locationName": "westus", + "failoverPriority": 1 + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGet.json new file mode 100644 index 000000000000..a0bbfd15a0cf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGet.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "ipRules": [], + "isVirtualNetworkFilterEnabled": false, + "virtualNetworkRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "defaultIdentity": "FirstPartyIdentity", + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "privateEndpointConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "cors": [], + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": true, + "enableBurstCapacity": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 8, + "backupStorageRedundancy": "Geo" + }, + "migrationState": { + "status": "InProgress", + "targetType": "Continuous", + "startTime": "2021-06-09T21:07:16Z" + } + }, + "networkAclBypass": "None", + "networkAclBypassResourceIds": [], + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + }, + "enablePartitionMerge": true, + "minimalTlsVersion": "Tls" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656", + "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d" + } + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json new file mode 100644 index 000000000000..b20a5213c423 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "timeGrain": "PT5M", + "retention": "P2D" + }, + { + "timeGrain": "PT1H", + "retention": "P14D" + }, + { + "timeGrain": "P1D", + "retention": "P60D" + } + ], + "primaryAggregationType": "Total", + "unit": "Count", + "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetMetrics.json new file mode 100644 index 000000000000..38136bfbef0b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetMetrics.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetUsages.json new file mode 100644 index 000000000000..38ef2fe2589e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountGetUsages.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountList.json new file mode 100644 index 000000000000..11dc5fb7c1f8 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountList.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "privateEndpointConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "cors": [], + "defaultIdentity": "FirstPartyIdentity", + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": true, + "enableBurstCapacity": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720, + "backupStorageRedundancy": "Geo" + } + }, + "networkAclBypass": "None", + "networkAclBypassResourceIds": [], + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + }, + "enablePartitionMerge": true, + "minimalTlsVersion": "Tls" + }, + "systemData": { + "createdAt": "2021-03-12T22:05:09Z" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656", + "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListByResourceGroup.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListByResourceGroup.json new file mode 100644 index 000000000000..5e4bcbc7b8b5 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListByResourceGroup.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "cors": [], + "enableFreeTier": false, + "defaultIdentity": "FirstPartyIdentity", + "networkAclBypass": "None", + "networkAclBypassResourceIds": [], + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + }, + "minimalTlsVersion": "Tls" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656", + "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListConnectionStrings.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListConnectionStrings.json new file mode 100644 index 000000000000..092eb0fe4744 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListConnectionStrings.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "connectionStrings": [ + { + "connectionString": "connection-string", + "description": "Primary SQL Connection String", + "keyKind": "Primary", + "type": "Sql" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json new file mode 100644 index 000000000000..4b5dde9108ab --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "mongo-ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "connectionStrings": [ + { + "connectionString": "connection-string", + "description": "Name of the connection string" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListKeys.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListKeys.json new file mode 100644 index 000000000000..8e68d8f666b4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryMasterKey": "primaryMasterKey", + "secondaryMasterKey": "secondaryMasterKey", + "primaryReadonlyMasterKey": "primaryReadonlyMasterKey", + "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json new file mode 100644 index 000000000000..0f5712deafc6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryReadonlyMasterKey": "primaryReadonlyMasterKey", + "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountOfflineRegion.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountOfflineRegion.json new file mode 100644 index 000000000000..cafebdf50e8b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountOfflineRegion.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "region": "North Europe", + "regionParameterForOffline": [ + { + "region": "North Europe" + } + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountOnlineRegion.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountOnlineRegion.json new file mode 100644 index 000000000000..b6590e5476b0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountOnlineRegion.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "region": "North Europe", + "regionParameterForOnline": [ + { + "region": "North Europe" + } + ] + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountPatch.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountPatch.json new file mode 100644 index 000000000000..cf0547cd64f2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountPatch.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "updateParameters": { + "location": "westus", + "tags": { + "dept": "finance" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "properties": { + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "isVirtualNetworkFilterEnabled": true, + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false + } + ], + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "defaultIdentity": "FirstPartyIdentity", + "enableFreeTier": false, + "enableAnalyticalStorage": true, + "enableBurstCapacity": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720, + "backupStorageRedundancy": "Local" + } + }, + "networkAclBypass": "AzureServices", + "networkAclBypassResourceIds": [ + "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName" + ], + "capacity": { + "totalThroughputLimit": 2000 + }, + "enablePartitionMerge": true, + "minimalTlsVersion": "Tls" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": { + "dept": "finance" + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656", + "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d", + "userAssignedIdentities": { + "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "fbe75b66-01c5-4f87-a220-233af3270436", + "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "databaseAccountOfferType": "Standard", + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "isVirtualNetworkFilterEnabled": true, + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false + } + ], + "privateEndpointConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "cors": [], + "defaultIdentity": "FirstPartyIdentity", + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": true, + "enableBurstCapacity": true, + "analyticalStorageConfiguration": { + "schemaType": "WellDefined" + }, + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720, + "backupStorageRedundancy": "Local" + } + }, + "networkAclBypass": "AzureServices", + "networkAclBypassResourceIds": [ + "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName" + ], + "capacity": { + "totalThroughputLimit": 2000 + }, + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + }, + "enablePartitionMerge": true, + "minimalTlsVersion": "Tls" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountRegenerateKey.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountRegenerateKey.json new file mode 100644 index 000000000000..315d8249d41e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountRegenerateKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "keyToRegenerate": { + "keyKind": "primary" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountRegionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountRegionGetMetrics.json new file mode 100644 index 000000000000..38cf5c57b35c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseAccountRegionGetMetrics.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "region": "North Europe", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseGetMetricDefinitions.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseGetMetricDefinitions.json new file mode 100644 index 000000000000..c1a2f30c7a92 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseGetMetricDefinitions.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "api-version": "2023-11-15", + "databaseRid": "databaseRid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "timeGrain": "PT5M", + "retention": "P2D" + }, + { + "timeGrain": "PT1H", + "retention": "P14D" + }, + { + "timeGrain": "P1D", + "retention": "P60D" + } + ], + "primaryAggregationType": "Total", + "unit": "Count", + "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseGetMetrics.json new file mode 100644 index 000000000000..9d7e01956640 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseGetMetrics.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseRid": "rid", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseGetUsages.json new file mode 100644 index 000000000000..864cbd56b370 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBDatabaseGetUsages.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "databaseRid": "databaseRid", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGraphAPIComputeServiceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGraphAPIComputeServiceCreate.json new file mode 100644 index 000000000000..3cf542a079a6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGraphAPIComputeServiceCreate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "GraphAPICompute", + "createUpdateParameters": { + "properties": { + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "GraphAPICompute" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/GraphAPICompute", + "name": "GraphAPICompute", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "GraphAPICompute", + "graphApiComputeEndpoint": "https://graphAPICompute.gremlin.cosmos.windows-int.net/", + "locations": [ + { + "name": "GraphAPICompute-westus2", + "location": "West US 2", + "status": "Running", + "graphApiComputeEndpoint": "https://graphAPICompute-westus.gremlin.cosmos.windows-int.net/" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGraphAPIComputeServiceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGraphAPIComputeServiceDelete.json new file mode 100644 index 000000000000..34f4dc5be94a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGraphAPIComputeServiceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "GraphAPICompute" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGraphAPIComputeServiceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGraphAPIComputeServiceGet.json new file mode 100644 index 000000000000..d5e315d532c4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGraphAPIComputeServiceGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "GraphAPICompute" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/GraphAPICompute", + "name": "GraphAPICompute", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "GraphAPICompute", + "graphApiComputeEndpoint": "https://graphAPICompute.gremlin.cosmos.windows-int.net/", + "locations": [ + { + "name": "GraphAPICompute-westus2", + "location": "West US 2", + "status": "Running", + "graphApiComputeEndpoint": "https://graphAPICompute-westus.gremlin.cosmos.windows-int.net/" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseCreateUpdate.json new file mode 100644 index 000000000000..f5b52d7c1728 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateGremlinDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseDelete.json new file mode 100644 index 000000000000..8b7772886e31 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseGet.json new file mode 100644 index 000000000000..322384e3776d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseList.json new file mode 100644 index 000000000000..d4780165d56a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..dfb77baa67d1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..e27b2476fcf7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseThroughputGet.json new file mode 100644 index 000000000000..46bdabcf3f99 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseThroughputGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseThroughputUpdate.json new file mode 100644 index 000000000000..ea5bf7547eb2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinDatabaseThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphBackupInformation.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphBackupInformation.json new file mode 100644 index 000000000000..16e06c30e063 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphBackupInformation.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "graphName": "graphName", + "location": { + "location": "North Europe" + } + }, + "responses": { + "200": { + "body": { + "continuousBackupInformation": { + "latestRestorableTimestamp": "2021-02-05T02:40:50Z" + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphCreateUpdate.json new file mode 100644 index 000000000000..c004f27dbc18 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphCreateUpdate.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName", + "createUpdateGremlinGraphParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "graphName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/gremlinGraphs/graphName", + "name": "graphName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/gremlinGraphs", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "graphName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphDelete.json new file mode 100644 index 000000000000..17a69171538a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphGet.json new file mode 100644 index 000000000000..00aa7bdbb626 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphGet.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "id": "graphName", + "name": "graphName", + "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs", + "properties": { + "resource": { + "id": "graphName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphList.json new file mode 100644 index 000000000000..4e1d32c89c68 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "testgrf", + "name": "testgrf", + "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs", + "properties": { + "resource": { + "id": "testgrf", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphMigrateToAutoscale.json new file mode 100644 index 000000000000..09a348488176 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphMigrateToAutoscale.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json new file mode 100644 index 000000000000..4566db78cc3f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphThroughputGet.json new file mode 100644 index 000000000000..7ea084bbcd78 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphThroughputGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/gremlinGraphs/graphName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphThroughputUpdate.json new file mode 100644 index 000000000000..3f2de146467b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBGremlinGraphThroughputUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/gremlinGraphs/graphName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationGet.json new file mode 100644 index 000000000000..a09df89a590d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus", + "type": "Microsoft.DocumentDB/locations", + "name": "westus", + "properties": { + "supportsAvailabilityZone": true, + "isResidencyRestricted": true, + "backupStorageRedundancies": [ + "Local", + "Geo" + ], + "isSubscriptionRegionAccessAllowedForRegular": true, + "isSubscriptionRegionAccessAllowedForAz": true, + "status": "Online" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationList.json new file mode 100644 index 000000000000..969bca10d37a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBLocationList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus", + "type": "Microsoft.DocumentDB/locations", + "name": "westus", + "properties": { + "supportsAvailabilityZone": false, + "isResidencyRestricted": false, + "backupStorageRedundancies": [ + "Local", + "Geo" + ], + "isSubscriptionRegionAccessAllowedForRegular": true, + "isSubscriptionRegionAccessAllowedForAz": false, + "status": "Online" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/centralus", + "type": "Microsoft.DocumentDB/locations", + "name": "centralus", + "properties": { + "supportsAvailabilityZone": true, + "isResidencyRestricted": false, + "backupStorageRedundancies": [ + "Zone", + "Geo" + ], + "isSubscriptionRegionAccessAllowedForRegular": false, + "isSubscriptionRegionAccessAllowedForAz": true, + "status": "Online" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterCreate.json new file mode 100644 index 000000000000..3bede79a6999 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterCreate.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod", + "body": { + "location": "West US", + "tags": {}, + "properties": { + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "initialCassandraAdminPassword": "mypassword", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterDeallocate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterDeallocate.json new file mode 100644 index 000000000000..b00434ebfeaf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterDeallocate.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterDelete.json new file mode 100644 index 000000000000..a4cedd4971c7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterGet.json new file mode 100644 index 000000000000..41e2872441ff --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterGet.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterListByResourceGroup.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterListByResourceGroup.json new file mode 100644 index 000000000000..83d3f02b0208 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterListByResourceGroup.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterListBySubscription.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterListBySubscription.json new file mode 100644 index 000000000000..c0d0923227aa --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterListBySubscription.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/cassandraClusters", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterPatch.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterPatch.json new file mode 100644 index 000000000000..140f476dba28 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterPatch.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod", + "body": { + "tags": { + "owner": "mike" + }, + "properties": { + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "hoursBetweenBackups": 12, + "authenticationMethod": "None" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2023-11-15" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": { + "owner": "mike" + }, + "properties": { + "provisioningState": "Updating", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod", + "name": "cassandra-prod", + "type": "Microsoft.DocumentDB/cassandraClusters", + "location": "West US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "delegatedManagementSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/management", + "cassandraVersion": "3.11", + "hoursBetweenBackups": 24, + "authenticationMethod": "Cassandra", + "externalSeedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + } + ], + "clusterNameOverride": "ClusterNameIllegalForAzureResource", + "seedNodes": [ + { + "ipAddress": "10.52.221.2" + }, + { + "ipAddress": "10.52.221.3" + }, + { + "ipAddress": "10.52.221.4" + }, + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "clientCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "externalGossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ], + "gossipCertificates": [ + { + "pem": "-----BEGIN CERTIFICATE-----\n...Base64 encoded certificate...\n-----END CERTIFICATE-----" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterStart.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterStart.json new file mode 100644 index 000000000000..b00434ebfeaf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraClusterStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraCommand.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraCommand.json new file mode 100644 index 000000000000..6f067da27162 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraCommand.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod", + "body": { + "command": "nodetool status", + "host": "10.0.1.12" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2023-11-15" + }, + "body": { + "commandOutput": "Datacenter: datacenter1\n=======================\n" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterCreate.json new file mode 100644 index 000000000000..05582f84cb1f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterCreate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod", + "dataCenterName": "dc1", + "body": { + "properties": { + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1-subnet", + "nodeCount": 9, + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Succeeded", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "seedNodes": [ + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Creating", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "seedNodes": [] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterDelete.json new file mode 100644 index 000000000000..123e79d96095 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod", + "dataCenterName": "dc1" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterGet.json new file mode 100644 index 000000000000..63775a08cd90 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod", + "dataCenterName": "dc1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Succeeded", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=", + "seedNodes": [ + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterList.json new file mode 100644 index 000000000000..dfe269620afd --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Succeeded", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "seedNodes": [ + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ], + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterPatch.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterPatch.json new file mode 100644 index 000000000000..3f66677fb45c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraDataCenterPatch.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod", + "dataCenterName": "dc1", + "body": { + "properties": { + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1-subnet", + "nodeCount": 9, + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DocumentDB/locations/westus2/operationsStatus/318653d0-3da5-4814-b8f6-429f2af0b2a4?api-version=2023-11-15" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Updating", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=", + "seedNodes": [ + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cassandra-prod-rg/providers/Microsoft.DocumentDB/cassandraClusters/cassandra-prod/dataCenters/dc1", + "name": "dc1", + "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters", + "properties": { + "provisioningState": "Succeeded", + "dataCenterLocation": "West US 2", + "delegatedSubnetId": "/subscriptions/536e130b-d7d6-4ac7-98a5-de20d69588d2/resourceGroups/customer-vnet-rg/providers/Microsoft.Network/virtualNetworks/customer-vnet/subnets/dc1", + "nodeCount": 9, + "base64EncodedCassandraYamlFragment": "Y29tcGFjdGlvbl90aHJvdWdocHV0X21iX3Blcl9zZWM6IDMyCmNvbXBhY3Rpb25fbGFyZ2VfcGFydGl0aW9uX3dhcm5pbmdfdGhyZXNob2xkX21iOiAxMDA=", + "seedNodes": [ + { + "ipAddress": "192.168.12.2" + }, + { + "ipAddress": "192.168.12.3" + }, + { + "ipAddress": "192.168.12.4" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraStatus.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraStatus.json new file mode 100644 index 000000000000..8bc4bbdbb000 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBManagedCassandraStatus.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "cassandra-prod-rg", + "api-version": "2023-11-15", + "clusterName": "cassandra-prod" + }, + "responses": { + "200": { + "body": { + "eTag": "A350A2CE7E91B6D5A102A5E5EC222B882D981092", + "reaperStatus": { + "healthy": true, + "repairRunIds": {}, + "repairSchedules": { + "00000000-0000-0001-0000-000000000000": "ACTIVE" + } + }, + "connectionErrors": [], + "dataCenters": [ + { + "name": "cassandra-westus2-vmss", + "seedNodes": [ + "10.0.8.10", + "10.0.8.11", + "10.0.8.12" + ], + "nodes": [ + { + "address": "10.0.8.10", + "state": "Normal", + "status": "Up", + "cassandraProcessStatus": "Running", + "load": "84.61 MiB", + "tokens": [ + "-7785254003841681178", + "-6756518164561476165", + "-4269720020504480060", + "-2697657908817852783", + "-2622387897201218249", + "-2177258200443022948", + "-129203941752875603", + "1738406920822650025", + "2598053056312400240", + "3227346424117996872", + "3644347038875498376", + "4823546474906050895", + "5293156680707616627", + "5485806686603256557", + "6250058817756969464", + "7991328665766267709" + ], + "size": 16, + "hostID": "8ccc00a7-9e22-4ac2-aa63-e5327aa0dc51", + "rack": "rack1", + "timestamp": "10/05/2021, 14:35:20.028", + "diskUsedKB": 749836, + "diskFreeKB": 1001260056, + "memoryUsedKB": 11061032, + "memoryBuffersAndCachedKB": 10817580, + "memoryFreeKB": 35731832, + "memoryTotalKB": 57610444, + "cpuUsage": 0.9 + }, + { + "address": "10.0.8.11", + "state": "Normal", + "status": "Up", + "cassandraProcessStatus": "Running", + "load": "59.67 MiB", + "tokens": [ + "-8726238055665903210", + "-6687985003871487470", + "-5269140854976433359", + "-3989177686905645288", + "-3957362495277148220", + "-2539287458896988944", + "-2460716365393303466", + "-1848370030729221440", + "137707733677015122", + "579467328507000597", + "1698264534774619627", + "1904235159942090722", + "3312208865519999146", + "4035940456270983993", + "4412314431151736777", + "8232565668795426078" + ], + "size": 16, + "hostID": "14092117-4f77-4ec0-8984-c5b860b88a47", + "rack": "rack2", + "timestamp": "10/05/2021, 14:35:20.028", + "diskUsedKB": 726864, + "diskFreeKB": 1001283028, + "memoryUsedKB": 11055676, + "memoryBuffersAndCachedKB": 10691520, + "memoryFreeKB": 35863248, + "memoryTotalKB": 57610444, + "cpuUsage": 1.2 + }, + { + "address": "10.0.8.12", + "state": "Normal", + "status": "Up", + "cassandraProcessStatus": "Running", + "load": "93.2 MiB", + "tokens": [ + "-5679481051867296621", + "-4574115287969297989", + "-3444578133211470522", + "-2755931580714972271", + "-2304431590844389550", + "-1961946736975068713", + "-940120277889446704", + "554469308917912318", + "1030447162050118004", + "2745632329542596589", + "4564547712926446283", + "5185613478135944116", + "7280237939830623824", + "7504213835759531710", + "7631994478195429959", + "8139769477321226157" + ], + "size": 16, + "hostID": "e16ada14-39db-462b-9f9e-5b5f6beb8bbd", + "rack": "rack3", + "timestamp": "10/05/2021, 14:35:20.028", + "diskUsedKB": 757540, + "diskFreeKB": 1001252352, + "memoryUsedKB": 11051608, + "memoryBuffersAndCachedKB": 10453856, + "memoryFreeKB": 36104980, + "memoryTotalKB": 57610444, + "cpuUsage": 0.4 + } + ] + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMaterializedViewsBuilderServiceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMaterializedViewsBuilderServiceCreate.json new file mode 100644 index 000000000000..100f3d5ef0b9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMaterializedViewsBuilderServiceCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "MaterializedViewsBuilder", + "createUpdateParameters": { + "properties": { + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "MaterializedViewsBuilder" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/MaterializedViewsBuilder", + "name": "MaterializedViewsBuilder", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "MaterializedViewsBuilder", + "locations": [ + { + "name": "MaterializedViewsBuilder-westus2", + "location": "West US 2", + "status": "Running" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMaterializedViewsBuilderServiceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMaterializedViewsBuilderServiceDelete.json new file mode 100644 index 000000000000..a42c3c362cc9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMaterializedViewsBuilderServiceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "MaterializedViewsBuilder" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMaterializedViewsBuilderServiceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMaterializedViewsBuilderServiceGet.json new file mode 100644 index 000000000000..c0783e22fd4c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMaterializedViewsBuilderServiceGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "MaterializedViewsBuilder" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/MaterializedViewsBuilder", + "name": "MaterializedViewsBuilder", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "MaterializedViewsBuilder", + "locations": [ + { + "name": "MaterializedViewsBuilder-westus2", + "location": "West US 2", + "status": "Running" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionBackupInformation.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionBackupInformation.json new file mode 100644 index 000000000000..f1ff087dacc4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionBackupInformation.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "collectionName": "collectionName", + "location": { + "location": "North Europe" + } + }, + "responses": { + "200": { + "body": { + "continuousBackupInformation": { + "latestRestorableTimestamp": "2021-02-05T02:40:50Z" + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionCreateUpdate.json new file mode 100644 index 000000000000..deac24be6d0f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionCreateUpdate.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName", + "createUpdateMongoDBCollectionParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "collectionName", + "indexes": [ + { + "key": { + "keys": [ + "_ts" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + }, + { + "key": { + "keys": [ + "_id" + ] + } + } + ], + "shardKey": { + "testKey": "Hash" + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName", + "name": "collectionName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "collectionName", + "indexes": [ + { + "key": { + "keys": [ + "_ts" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + }, + { + "key": { + "keys": [ + "_id" + ] + } + } + ], + "shardKey": { + "testKey": "Hash" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionDelete.json new file mode 100644 index 000000000000..0c8f5a39c9b3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionGet.json new file mode 100644 index 000000000000..36b7794224cc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName", + "name": "collectionName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testcoll", + "indexes": [ + { + "key": { + "keys": [ + "testKey" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + } + ], + "shardKey": { + "testKey": "Hash" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionList.json new file mode 100644 index 000000000000..f4d1c1fd43a3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName", + "name": "collectionName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testcoll", + "indexes": [ + { + "key": { + "keys": [ + "testKey" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + } + ], + "shardKey": { + "testKey": "Hash" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json new file mode 100644 index 000000000000..b0e58595a99b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json new file mode 100644 index 000000000000..f8a160a8272a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionThroughputGet.json new file mode 100644 index 000000000000..e70cf18356cd --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionThroughputGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionThroughputUpdate.json new file mode 100644 index 000000000000..bf515dc45949 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBCollectionThroughputUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseCreateUpdate.json new file mode 100644 index 000000000000..d8ac32e9e122 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseCreateUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateMongoDBDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "updatedDatabaseName" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseDelete.json new file mode 100644 index 000000000000..8b7772886e31 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseGet.json new file mode 100644 index 000000000000..933fda22c210 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseList.json new file mode 100644 index 000000000000..64ba0c69b4b8 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..dfb77baa67d1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..e27b2476fcf7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputGet.json new file mode 100644 index 000000000000..0d718ab879ad --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json new file mode 100644 index 000000000000..be26b005e10a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json new file mode 100644 index 000000000000..1ef0e43e03e8 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "mongoRoleDefinitionId": "myMongoRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15", + "createUpdateMongoRoleDefinitionParameters": { + "properties": { + "roleName": "myRoleName", + "databaseName": "sales", + "privileges": [ + { + "resource": { + "db": "sales", + "collection": "sales" + }, + "actions": [ + "insert", + "find" + ] + } + ], + "roles": [ + { + "role": "myInheritedRole", + "db": "sales" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbRoleDefinitions/myMongoDbRoleDefinitionId", + "name": "myMongoDbRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/mongoDbRoleDefinitionId", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "databaseName": "sales", + "privileges": [ + { + "resource": { + "db": "sales", + "collection": "coll" + }, + "actions": [ + "find", + "insert" + ] + } + ], + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionDelete.json new file mode 100644 index 000000000000..02cf6749f743 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "mongoRoleDefinitionId": "myMongoRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionGet.json new file mode 100644 index 000000000000..f2e89937f80c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "mongoRoleDefinitionId": "myMongoRoleDefinitionId", + "databaseName": "sales", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbRoleDefinitions/myMongoDbRoleDefinitionId", + "name": "myMongoRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "databaseName": "sales", + "privileges": [ + { + "resource": { + "db": "sales", + "collection": "coll" + }, + "actions": [ + "find", + "insert" + ] + } + ], + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionList.json new file mode 100644 index 000000000000..637fec324c4e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBRoleDefinitionList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "databaseName": "sales", + "privileges": [ + { + "resource": { + "db": "sales", + "collection": "coll" + }, + "actions": [ + "find", + "insert" + ] + } + ], + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json new file mode 100644 index 000000000000..f62b8b5cae4c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "mongoUserDefinitionId": "myMongoUserDefinitionId", + "databaseName": "sales", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15", + "createUpdateMongoUserDefinitionParameters": { + "properties": { + "userName": "myUserName", + "password": "myPassword", + "databaseName": "sales", + "customData": "My custom data", + "roles": [ + { + "role": "myReadRole", + "db": "sales" + } + ], + "mechanisms": "SCRAM-SHA-256" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myUserId", + "name": "myUserName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions", + "properties": { + "userName": "myUserName", + "databaseName": "sales", + "customData": "My custom data", + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ], + "mechanisms": "SCRAM-SHA-256" + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionDelete.json new file mode 100644 index 000000000000..6d26daaccca4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "mongoUserDefinitionId": "myMongoUserDefinitionId", + "databaseName": "sales", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionGet.json new file mode 100644 index 000000000000..5eaa7ac62884 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "mongoUserDefinitionId": "myMongoUserDefinitionId", + "databaseName": "sales", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myUserId", + "name": "myUserId", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions", + "properties": { + "userName": "myUserName", + "databaseName": "sales", + "customData": "My custom data", + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ], + "mechanisms": "SCRAM-SHA-256" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionList.json new file mode 100644 index 000000000000..084ee8347696 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBUserDefinitionList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbUserDefinitions/myUserId", + "name": "myUserId", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions", + "properties": { + "userName": "myUserName", + "databaseName": "sales", + "customData": "My custom data", + "roles": [ + { + "db": "sales", + "role": "myReadRole" + } + ], + "mechanisms": "SCRAM-SHA-256" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceCreate.json new file mode 100644 index 000000000000..be69491b3cbc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceCreate.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default", + "notebookCreateUpdateParameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces", + "properties": { + "notebookServerEndpoint": "endpoint", + "status": "Online" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceDelete.json new file mode 100644 index 000000000000..8ff459dc9bb6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "notebookWorkspaceName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceGet.json new file mode 100644 index 000000000000..26558bcf9ecc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces", + "properties": { + "notebookServerEndpoint": "endpoint", + "status": "Online" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceList.json new file mode 100644 index 000000000000..f4f191ed57a9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces", + "properties": { + "notebookServerEndpoint": "endpoint", + "status": "Online" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json new file mode 100644 index 000000000000..084e58653684 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": { + "body": { + "authToken": "auth-token", + "notebookServerEndpoint": "notebook endpoint" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json new file mode 100644 index 000000000000..8fc52d39fa71 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceStart.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceStart.json new file mode 100644 index 000000000000..8fc52d39fa71 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBNotebookWorkspaceStart.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBOperationsList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBOperationsList.json new file mode 100644 index 000000000000..c1647685f5dc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBOperationsList.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "operationName", + "display": { + "Provider": "providerName", + "Resource": "resourceName", + "Operation": "operationName", + "Description": "description" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPKeyRangeIdGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPKeyRangeIdGetMetrics.json new file mode 100644 index 000000000000..793c84af530b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPKeyRangeIdGetMetrics.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "partitionKeyRangeId": "0", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json new file mode 100644 index 000000000000..cdc683df3727 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "partitionKeyRangeId": "0", + "region": "West US", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPercentileGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPercentileGetMetrics.json new file mode 100644 index 000000000000..ce3f194444dd --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPercentileGetMetrics.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "$filter": "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-East US" + } + }, + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-West US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-West US" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPercentileSourceTargetGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPercentileSourceTargetGetMetrics.json new file mode 100644 index 000000000000..d872924f5601 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPercentileSourceTargetGetMetrics.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "sourceRegion": "West Central US", + "targetRegion": "East US", + "$filter": "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-East US" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPercentileTargetGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPercentileTargetGetMetrics.json new file mode 100644 index 000000000000..4a373fc9051b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPercentileTargetGetMetrics.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "targetRegion": "East US", + "$filter": "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-East US" + } + }, + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-West US" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..c2f9287e06fb --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2023-11-15", + "privateEndpointConnectionName": "privateEndpointConnectionName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..ba115a598810 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2023-11-15", + "privateEndpointConnectionName": "privateEndpointConnectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupId": "Sql", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionListGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionListGet.json new file mode 100644 index 000000000000..8625a56c92cd --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionListGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupId": "Sql", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName2", + "name": "privateEndpointConnectionName", + "type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupId": "Sql", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..b8c0b92d7d3c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateEndpointConnectionUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2023-11-15", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupId": "Sql", + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateLinkResourceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateLinkResourceGet.json new file mode 100644 index 000000000000..319793382c9d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateLinkResourceGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2023-11-15", + "groupName": "sql" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateLinkResources/sql", + "name": "sql", + "type": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources", + "properties": { + "groupId": "sql", + "requiredMembers": [ + "ddb1", + "ddb1-westus" + ], + "requiredZoneNames": [ + "privatelink.documents.azure.net" + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateLinkResourceListGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateLinkResourceListGet.json new file mode 100644 index 000000000000..8926a66d198c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBPrivateLinkResourceListGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateLinkResources/sql", + "name": "sql", + "type": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources", + "properties": { + "groupId": "sql", + "requiredMembers": [ + "ddb1", + "ddb1-westus" + ], + "requiredZoneNames": [ + "privatelink.documents.azure.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRegionCollectionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRegionCollectionGetMetrics.json new file mode 100644 index 000000000000..2e4608dd8853 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRegionCollectionGetMetrics.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "region": "North Europe", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableDatabaseAccountGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableDatabaseAccountGet.json new file mode 100644 index 000000000000..49c1b55b6806 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableDatabaseAccountGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "location": "West US", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d", + "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb1", + "creationTime": "2020-04-11T21:56:15Z", + "deletionTime": "2021-03-12T22:05:09Z", + "oldestRestorableTime": "2021-03-01T22:05:09Z", + "apiType": "Sql", + "restorableLocations": [ + { + "locationName": "South Central US", + "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" + }, + { + "locationName": "West US", + "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", + "creationTime": "2020-10-30T21:13:10Z" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableDatabaseAccountList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableDatabaseAccountList.json new file mode 100644 index 000000000000..901ad5572515 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableDatabaseAccountList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "location": "West US" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d", + "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb1", + "creationTime": "2020-04-11T21:56:15Z", + "deletionTime": "2021-03-12T22:05:09Z", + "oldestRestorableTime": "2021-03-12T22:05:09Z", + "apiType": "Sql", + "restorableLocations": [ + { + "locationName": "South Central US", + "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" + }, + { + "locationName": "West US", + "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", + "creationTime": "2020-10-30T21:13:10Z" + } + ] + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "name": "4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb2", + "creationTime": "2020-05-01T08:05:18Z", + "oldestRestorableTime": "2020-05-01T08:05:18Z", + "apiType": "Sql", + "restorableLocations": [ + { + "locationName": "South Central US", + "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" + }, + { + "locationName": "West US", + "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", + "creationTime": "2020-10-30T21:13:10Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json new file mode 100644 index 000000000000..8d103ca5b49e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d", + "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb1", + "creationTime": "2020-04-11T21:56:15Z", + "deletionTime": "2021-03-12T22:05:09Z", + "oldestRestorableTime": "2021-03-12T22:05:09Z", + "apiType": "Sql", + "restorableLocations": [ + { + "locationName": "South Central US", + "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" + }, + { + "locationName": "West US", + "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", + "creationTime": "2020-10-30T21:13:10Z" + } + ] + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "name": "4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "location": "East US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb2", + "creationTime": "2020-05-01T08:05:18Z", + "oldestRestorableTime": "2020-05-01T08:05:18Z", + "apiType": "Sql", + "restorableLocations": [ + { + "locationName": "South Central US", + "regionalDatabaseAccountInstanceId": "d7a01f78-606f-45c6-9dac-0df32f433bb5", + "creationTime": "2020-10-30T21:13:10Z", + "deletionTime": "2020-10-30T21:13:35Z" + }, + { + "locationName": "West US", + "regionalDatabaseAccountInstanceId": "fdb43d84-1572-4697-b6e7-2bcda0c51b2c", + "creationTime": "2020-10-30T21:13:10Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinDatabaseList.json new file mode 100644 index 000000000000..2766f1d90980 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinDatabaseList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableGremlinDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases", + "name": "59c21367-b98b-4a8e-abb7-b6f46600decc", + "properties": { + "resource": { + "_rid": "DLB14gAAAA==", + "eventTimestamp": "2020-09-02T19:45:03Z", + "ownerId": "Database1", + "ownerResourceId": "PD5DALigDgw=", + "operationType": "Create", + "canUndelete": "invalid" + } + } + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinDatabases", + "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "properties": { + "resource": { + "_rid": "ESXNLAAAAA==", + "eventTimestamp": "2020-09-02T19:53:42Z", + "ownerId": "Database1", + "ownerResourceId": "PD5DALigDgw=", + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account." + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinGraphList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinGraphList.json new file mode 100644 index 000000000000..f45af1ddd4f6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinGraphList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "location": "WestUS", + "instanceId": "98a570f2-63db-4117-91f0-366327b7b353", + "restorableGremlinDatabaseRid": "PD5DALigDgw=" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGraphs", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Graph1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Create", + "canUndelete": "invalid" + } + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGraphs", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Graph1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Individual shared database collections restore is not supported. Please restore shared database to restore its collections that share the throughput." + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinResourceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinResourceList.json new file mode 100644 index 000000000000..1b1209728835 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableGremlinResourceList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "restoreLocation": "WestUS", + "restoreTimestampInUtc": "06/01/2022 4:56" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database1", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources", + "name": "Database1", + "databaseName": "Database1", + "graphNames": [ + "Graph1" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database2", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources", + "name": "Database2", + "databaseName": "Database2", + "graphNames": [ + "Graph1", + "Graph2" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database3", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources", + "name": "Database3", + "databaseName": "Database3", + "graphNames": [] + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableMongodbCollectionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableMongodbCollectionList.json new file mode 100644 index 000000000000..64b3d03163cc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableMongodbCollectionList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "location": "WestUS", + "instanceId": "98a570f2-63db-4117-91f0-366327b7b353", + "restorableMongodbDatabaseRid": "PD5DALigDgw=" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbCollections", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Collection1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Create", + "canUndelete": "invalid" + } + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbCollections", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Collection1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Individual shared database collections restore is not supported. Please restore shared database to restore its collections that share the throughput." + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableMongodbDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableMongodbDatabaseList.json new file mode 100644 index 000000000000..9dc3e71dff2c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableMongodbDatabaseList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableMongodbDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbDatabases", + "name": "59c21367-b98b-4a8e-abb7-b6f46600decc", + "properties": { + "resource": { + "_rid": "DLB14gAAAA==", + "eventTimestamp": "2020-09-02T19:45:03Z", + "ownerId": "Database1", + "ownerResourceId": "PD5DALigDgw=", + "operationType": "Create", + "canUndelete": "invalid" + } + } + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableMongodbDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbDatabases", + "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "properties": { + "resource": { + "_rid": "ESXNLAAAAA==", + "eventTimestamp": "2020-09-02T19:53:42Z", + "ownerId": "Database1", + "ownerResourceId": "PD5DALigDgw=", + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account." + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableMongodbResourceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableMongodbResourceList.json new file mode 100644 index 000000000000..ab8a41d73ea5 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableMongodbResourceList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "restoreLocation": "WestUS", + "restoreTimestampInUtc": "06/01/2022 4:56" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablemongodbresources/Database1", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablemongodbresources", + "name": "Database1", + "databaseName": "Database1", + "collectionNames": [ + "Collection1" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablemongodbresources/Database2", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablemongodbresources", + "name": "Database2", + "databaseName": "Database2", + "collectionNames": [ + "Collection1", + "Collection2" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablemongodbresources/Database3", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablemongodbresources", + "name": "Database3", + "databaseName": "Database3", + "collectionNames": [] + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableSqlContainerList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableSqlContainerList.json new file mode 100644 index 000000000000..3f4c6321b21d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableSqlContainerList.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "location": "WestUS", + "instanceId": "98a570f2-63db-4117-91f0-366327b7b353", + "restorableSqlDatabaseRid": "3fu-hg==" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Container1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Create", + "canUndelete": "invalid", + "container": { + "id": "Container1", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*" + }, + { + "path": "/\"_ts\"/?" + } + ], + "excludedPaths": [ + { + "path": "/\"_etag\"/?" + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/_ts", + "conflictResolutionProcedure": "" + }, + "_rid": "V18LoLrv-qA=", + "_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/", + "_etag": "\"00003e00-0000-0700-0000-5f85338a0000\"" + } + } + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/e85298a1-c631-4726-825e-a7ca092e9098", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers", + "name": "e85298a1-c631-4726-825e-a7ca092e9098", + "properties": { + "resource": { + "_rid": "PrArcgAAAA==", + "eventTimestamp": "2020-10-13T05:03:27Z", + "ownerId": "Container1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Replace", + "canUndelete": "invalid", + "container": { + "id": "Container1", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*" + }, + { + "path": "/\"_ts\"/?" + } + ], + "excludedPaths": [ + { + "path": "/\"_etag\"/?" + } + ] + }, + "defaultTtl": 12345, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/_ts", + "conflictResolutionProcedure": "" + }, + "_rid": "V18LoLrv-qA=", + "_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/", + "_etag": "\"00004400-0000-0700-0000-5f85351f0000\"" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableSqlDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableSqlDatabaseList.json new file mode 100644 index 000000000000..be5451e06169 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableSqlDatabaseList.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableSqlDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases", + "name": "59c21367-b98b-4a8e-abb7-b6f46600decc", + "properties": { + "resource": { + "_rid": "DLB14gAAAA==", + "eventTimestamp": "2020-09-02T19:45:03Z", + "ownerId": "Database1", + "ownerResourceId": "3fu-hg==", + "operationType": "Create", + "canUndelete": "invalid", + "database": { + "id": "Database1", + "_rid": "3fu-hg==", + "_self": "dbs/3fu-hg==/", + "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"", + "_colls": "colls/", + "_users": "users/" + } + } + } + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases", + "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257", + "properties": { + "resource": { + "_rid": "ESXNLAAAAA==", + "eventTimestamp": "2020-09-02T19:53:42Z", + "ownerId": "Database1", + "ownerResourceId": "3fu-hg==", + "database": { + "id": "Database1", + "_rid": "3fu-hg==", + "_self": "dbs/3fu-hg==/", + "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"", + "_colls": "colls/", + "_users": "users/", + "_ts": 1599075903 + }, + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account." + } + } + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/2c07991b-9c7c-4e85-be68-b18c1f2ff326", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases", + "name": "2c07991b-9c7c-4e85-be68-b18c1f2ff326", + "properties": { + "resource": { + "_rid": "aXFqUQAAAA==", + "eventTimestamp": "2020-09-02T19:53:15Z", + "ownerId": "Database2", + "ownerResourceId": "0SziSg==", + "database": { + "id": "Database2", + "_rid": "0SziSg==", + "_self": "dbs/0SziSg==/", + "_etag": "\"0000ca0a-0000-0700-0000-5f4ff82b0000\"", + "_colls": "colls/", + "_users": "users/" + }, + "operationType": "Create", + "canUndelete": "invalid" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableSqlResourceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableSqlResourceList.json new file mode 100644 index 000000000000..f00598aa80eb --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableSqlResourceList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "restoreLocation": "WestUS", + "restoreTimestampInUtc": "06/01/2022 4:56" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database1", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources", + "name": "Database1", + "databaseName": "Database1", + "collectionNames": [ + "Container1" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database2", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources", + "name": "Database2", + "databaseName": "Database2", + "collectionNames": [ + "Container1", + "Container2" + ] + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database3", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources", + "name": "Database3", + "databaseName": "Database3", + "collectionNames": [] + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableTableList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableTableList.json new file mode 100644 index 000000000000..c86f5b1b7cbc --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableTableList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "location": "WestUS", + "instanceId": "98a570f2-63db-4117-91f0-366327b7b353" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableTables/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableTables", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Table1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Create", + "canUndelete": "invalid" + } + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableTables/79609a98-3394-41f8-911f-cfab0c075c86", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableTables", + "name": "79609a98-3394-41f8-911f-cfab0c075c86", + "properties": { + "resource": { + "_rid": "zAyAPQAAAA==", + "eventTimestamp": "2020-10-13T04:56:42Z", + "ownerId": "Table1", + "ownerResourceId": "V18LoLrv-qA=", + "operationType": "Delete", + "canUndelete": "notRestorable", + "canUndeleteReason": "Collection with same name already exist as live collection." + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableTableResourceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableTableResourceList.json new file mode 100644 index 000000000000..2c6bccc5c8eb --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestorableTableResourceList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "2296c272-5d55-40d9-bc05-4d56dc2d7588", + "location": "WestUS", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "restoreLocation": "WestUS", + "restoreTimestampInUtc": "06/01/2022 4:56" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorabletableresources/table1", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources", + "name": "table1" + }, + { + "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorabletableresources/table2", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources", + "name": "table2" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json new file mode 100644 index 000000000000..af2419c3b4ab --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "createUpdateParameters": { + "location": "westus", + "tags": {}, + "kind": "GlobalDocumentDB", + "properties": { + "databaseAccountOfferType": "Standard", + "locations": [ + { + "failoverPriority": 0, + "locationName": "southcentralus", + "isZoneRedundant": false + } + ], + "createMode": "Restore", + "restoreParameters": { + "restoreMode": "PointInTime", + "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc", + "restoreTimestampInUtc": "2021-03-11T22:05:09Z", + "databasesToRestore": [ + { + "databaseName": "db1", + "collectionNames": [ + "collection1", + "collection2" + ] + }, + { + "databaseName": "db2", + "collectionNames": [ + "collection3", + "collection4" + ] + } + ] + }, + "backupPolicy": { + "type": "Continuous", + "continuousModeProperties": { + "tier": "Continuous30Days" + } + }, + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "keyVaultKeyUri": "https://myKeyVault.vault.azure.net", + "enableFreeTier": false, + "apiProperties": { + "serverVersion": "3.2" + }, + "enableAnalyticalStorage": true, + "minimalTlsVersion": "Tls" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Initializing", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Restore", + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "readLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "locations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "failoverPolicies": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "failoverPriority": 0 + } + ], + "backupPolicy": { + "type": "Continuous", + "continuousModeProperties": { + "tier": "Continuous30Days" + } + }, + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": false, + "keysMetadata": { + "primaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "primaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + }, + "secondaryReadonlyMasterKey": { + "generationTime": "2022-02-25T20:30:11Z" + } + }, + "minimalTlsVersion": "Tls" + }, + "systemData": { + "createdAt": "2021-03-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBServicesList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBServicesList.json new file mode 100644 index 000000000000..b118b3ee4031 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBServicesList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/sqlDedicatedGateway", + "name": "sqlDedicatedGateway", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "SqlDedicatedGateway", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway.sqlx.cosmos.windows-int.net/", + "locations": [ + { + "name": "sqlDedicatedGateway-westus2", + "location": "West US 2", + "status": "Running", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway-westus.sqlx.cosmos.windows-int.net/" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json new file mode 100644 index 000000000000..f4bc359f0db2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "accountName": "accountName", + "databaseName": "databaseName", + "clientEncryptionKeyName": "cekName", + "createUpdateClientEncryptionKeyParameters": { + "properties": { + "resource": { + "id": "cekName", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "wrappedDataEncryptionKey": "U3dhZ2dlciByb2Nrcw==", + "keyWrapMetadata": { + "name": "customerManagedKey", + "type": "AzureKeyVault", + "value": "AzureKeyVault Key URL", + "algorithm": "RSA-OAEP" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName", + "name": "cekName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKey", + "properties": { + "resource": { + "id": "cekName", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "wrappedDataEncryptionKey": "U3dhZ2dlciByb2Nrcw==", + "keyWrapMetadata": { + "name": "customerManagedKey", + "type": "AzureKeyVault", + "value": "AzureKeyVault Key URL", + "algorithm": "RSA-OAEP" + }, + "_rid": "tNc4AAAAAAAQkjzWAgAAAA==", + "_ts": 1626425552, + "_etag": "00000000-0000-0000-7a1f-bc0828e801d7" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlClientEncryptionKeyGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlClientEncryptionKeyGet.json new file mode 100644 index 000000000000..4ecf344eae8c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlClientEncryptionKeyGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "accountName": "accountName", + "databaseName": "databaseName", + "clientEncryptionKeyName": "cekName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName", + "name": "cekName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKey", + "properties": { + "resource": { + "id": "cekName", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "wrappedDataEncryptionKey": "U3dhZ2dlciByb2Nrcw==", + "keyWrapMetadata": { + "name": "customerManagedKey", + "type": "AzureKeyVault", + "value": "AzureKeyVault Key URL", + "algorithm": "RSA-OAEP" + }, + "_rid": "tNc4AAAAAAAQkjzWAgAAAA==", + "_ts": 1626425552, + "_etag": "00000000-0000-0000-7a1f-bc0828e801d7" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlClientEncryptionKeysList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlClientEncryptionKeysList.json new file mode 100644 index 000000000000..df3861755ca2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlClientEncryptionKeysList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subId", + "resourceGroupName": "rgName", + "accountName": "accountName", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName1", + "name": "cekName1", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKey", + "properties": { + "resource": { + "id": "cekName1", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "wrappedDataEncryptionKey": "U3dhZ2dlciByb2Nrcw==", + "keyWrapMetadata": { + "name": "customerManagedKey1", + "type": "AzureKeyVault", + "value": "AzureKeyVault Key URL for customerManagedKey1", + "algorithm": "RSA-OAEP" + }, + "_rid": "nAMyAAAAAADPw1kKAgAAAA==", + "_ts": 1626425552, + "_etag": "00000000-0000-0000-7a1f-bc0828e801d7" + } + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName2", + "name": "cekName2", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKey", + "properties": { + "resource": { + "id": "cekName2", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "wrappedDataEncryptionKey": "U3dhZ2dlciByb2Nrcw==", + "keyWrapMetadata": { + "name": "customerManagedKey2", + "type": "AzureKeyVault", + "value": "AzureKeyVault Key URL for customerManagedKey2", + "algorithm": "RSA-OAEP" + }, + "_rid": "nAMyAAAAAAAWWfxHAgAAAA==", + "_ts": 1626425631, + "_etag": "00000000-0000-0000-7a21-7788a38c01d7" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerBackupInformation.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerBackupInformation.json new file mode 100644 index 000000000000..3491a3fde835 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerBackupInformation.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "location": { + "location": "North Europe" + } + }, + "responses": { + "200": { + "body": { + "continuousBackupInformation": { + "latestRestorableTimestamp": "2021-02-05T02:40:50Z" + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerCreateUpdate.json new file mode 100644 index 000000000000..7e9918111099 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerCreateUpdate.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "createUpdateSqlContainerParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 2 + }, + "computedProperties": [ + { + "name": "cp_lowerName", + "query": "SELECT VALUE LOWER(c.name) FROM c" + } + ] + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName", + "name": "containerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "computedProperties": [ + { + "name": "cp_lowerName", + "query": "SELECT VALUE LOWER(c.name) FROM c" + } + ], + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerDelete.json new file mode 100644 index 000000000000..e00ea53d8676 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerGet.json new file mode 100644 index 000000000000..7cce5d95d83b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerGet.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName", + "name": "containerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "computedProperties": [ + { + "name": "cp_lowerName", + "query": "SELECT VALUE LOWER(c.name) FROM c" + } + ], + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + }, + "options": { + "throughput": 400 + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerList.json new file mode 100644 index 000000000000..720dd96cf9bf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerList.json @@ -0,0 +1,232 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName", + "name": "containerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testctn", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "computedProperties": [ + { + "name": "cp_lowerName", + "query": "SELECT VALUE LOWER(c.name) FROM c" + } + ], + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName1", + "name": "containerName1", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testctn1", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber", + "/AccountLocation" + ], + "kind": "MultiHash", + "version": 2 + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "computedProperties": [], + "_rid": "PD5DALigDiw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName2", + "name": "containerName2", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testctn2", + "indexingPolicy": { + "indexingMode": "consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/_partitionKey" + ], + "kind": "Hash", + "version": 2, + "systemKey": true + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "clientEncryptionPolicy": { + "includedPaths": [ + { + "path": "/path", + "clientEncryptionKeyId": "keyId", + "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256", + "encryptionType": "Deterministic" + } + ], + "policyFormatVersion": 1 + }, + "_rid": "PD5DALigDhw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerMigrateToAutoscale.json new file mode 100644 index 000000000000..28da40a29d51 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerMigrateToAutoscale.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerMigrateToManualThroughput.json new file mode 100644 index 000000000000..edcc438cb228 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerMigrateToManualThroughput.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerThroughputGet.json new file mode 100644 index 000000000000..5cd1d832a68f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerThroughputGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerThroughputUpdate.json new file mode 100644 index 000000000000..a3f5a6cbeabe --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlContainerThroughputUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseCreateUpdate.json new file mode 100644 index 000000000000..52b38432ec66 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateSqlDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseDelete.json new file mode 100644 index 000000000000..8b7772886e31 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseGet.json new file mode 100644 index 000000000000..33915e68d4c7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"", + "_colls": "colls/", + "_users": "users/" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseList.json new file mode 100644 index 000000000000..e20657870d41 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"", + "_colls": "colls/", + "_users": "users/" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..dfb77baa67d1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..e27b2476fcf7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseThroughputGet.json new file mode 100644 index 000000000000..834c4d724848 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseThroughputGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseThroughputUpdate.json new file mode 100644 index 000000000000..f9ccbbe65203 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDatabaseThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDedicatedGatewayServiceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDedicatedGatewayServiceCreate.json new file mode 100644 index 000000000000..a7f0f3c0834a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDedicatedGatewayServiceCreate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "SqlDedicatedGateway", + "createUpdateParameters": { + "properties": { + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "SqlDedicatedGateway" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/SqlDedicatedGateway", + "name": "SqlDedicatedGateway", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "SqlDedicatedGateway", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway.sqlx.cosmos.windows-int.net/", + "locations": [ + { + "name": "SqlDedicatedGateway-westus2", + "location": "West US 2", + "status": "Running", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway-westus.sqlx.cosmos.windows-int.net/" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDedicatedGatewayServiceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDedicatedGatewayServiceDelete.json new file mode 100644 index 000000000000..1d16af2d3fac --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDedicatedGatewayServiceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "SqlDedicatedGateway" + }, + "responses": { + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDedicatedGatewayServiceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDedicatedGatewayServiceGet.json new file mode 100644 index 000000000000..c81ee54840c8 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlDedicatedGatewayServiceGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "serviceName": "SqlDedicatedGateway" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/services/SqlDedicatedGateway", + "name": "SqlDedicatedGateway", + "type": "Microsoft.DocumentDB/databaseAccounts/services", + "properties": { + "status": "Running", + "creationTime": "2021-01-25T12:56:05.4622517Z", + "instanceSize": "Cosmos.D4s", + "instanceCount": 1, + "serviceType": "SqlDedicatedGateway", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway.sqlx.cosmos.windows-int.net/", + "locations": [ + { + "name": "SqlDedicatedGateway-westus2", + "location": "West US 2", + "status": "Running", + "sqlDedicatedGatewayEndpoint": "https://sqlDedicatedGateway-westus.sqlx.cosmos.windows-int.net/" + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json new file mode 100644 index 000000000000..a98540564b84 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "roleAssignmentId": "myRoleAssignmentId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15", + "createUpdateSqlRoleAssignmentParameters": { + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleAssignments/myRoleAssignmentId", + "name": "myRoleAssignmentId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments", + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentDelete.json new file mode 100644 index 000000000000..114dbc30a446 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "roleAssignmentId": "myRoleAssignmentId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentGet.json new file mode 100644 index 000000000000..8168aa94cd42 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "roleAssignmentId": "myRoleAssignmentId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleAssignments/myRoleAssignmentId", + "name": "myRoleAssignmentId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments", + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentList.json new file mode 100644 index 000000000000..ca68817a0813 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleAssignmentList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleAssignments/myRoleAssignmentId", + "name": "myRoleAssignmentId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments", + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json new file mode 100644 index 000000000000..3f9c3369a8f1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "roleDefinitionId": "myRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15", + "createUpdateSqlRoleDefinitionParameters": { + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ], + "notDataActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionDelete.json new file mode 100644 index 000000000000..b7446adcef10 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "roleDefinitionId": "myRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + }, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionGet.json new file mode 100644 index 000000000000..9038fdef1158 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "roleDefinitionId": "myRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ], + "notDataActions": [] + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionList.json new file mode 100644 index 000000000000..d1de6b825965 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlRoleDefinitionList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2023-11-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ], + "notDataActions": [] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureCreateUpdate.json new file mode 100644 index 000000000000..a54934965850 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "storedProcedureName": "storedProcedureName", + "createUpdateSqlStoredProcedureParameters": { + "properties": { + "resource": { + "id": "storedProcedureName", + "body": "body" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName", + "name": "storedProcedureName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures", + "properties": { + "resource": { + "id": "storedProcedureName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureDelete.json new file mode 100644 index 000000000000..8c49f67ba02c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "storedProcedureName": "storedProcedureName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureGet.json new file mode 100644 index 000000000000..f6666a265a68 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "storedProcedureName": "storedProcedureName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName", + "name": "storedProcedureName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures", + "properties": { + "resource": { + "id": "storedProcedureName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureList.json new file mode 100644 index 000000000000..8bd3c7c4b342 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlStoredProcedureList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName", + "name": "testctn", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures", + "properties": { + "resource": { + "id": "testctn", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerCreateUpdate.json new file mode 100644 index 000000000000..35e657118caf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerCreateUpdate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "triggerName": "triggerName", + "createUpdateSqlTriggerParameters": { + "properties": { + "resource": { + "id": "triggerName", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlTriggers/triggerName", + "name": "triggerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlTriggers", + "properties": { + "resource": { + "id": "triggerName", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerDelete.json new file mode 100644 index 000000000000..46b8374344aa --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "triggerName": "triggerName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerGet.json new file mode 100644 index 000000000000..28b2c8242550 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "triggerName": "triggerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlTriggers/triggerName", + "name": "triggerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlTriggers", + "properties": { + "resource": { + "id": "triggerName", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerList.json new file mode 100644 index 000000000000..04c1596cbaa1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlTriggerList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlTriggers/triggerName", + "name": "testctn", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlTriggers", + "properties": { + "resource": { + "id": "testctn", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json new file mode 100644 index 000000000000..1a1fc1b2168f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "userDefinedFunctionName": "userDefinedFunctionName", + "createUpdateSqlUserDefinedFunctionParameters": { + "properties": { + "resource": { + "id": "userDefinedFunctionName", + "body": "body" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlUserDefinedFunctions/userDefinedFunctionName", + "name": "userDefinedFunctionName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlUserDefinedFunctions", + "properties": { + "resource": { + "id": "userDefinedFunctionName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionDelete.json new file mode 100644 index 000000000000..b0e5794a96c6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "userDefinedFunctionName": "userDefinedFunctionName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionGet.json new file mode 100644 index 000000000000..e70ecfbb8cdb --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "userDefinedFunctionName": "userDefinedFunctionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlUserDefinedFunctions/userDefinedFunctionName", + "name": "userDefinedFunctionName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlUserDefinedFunctions", + "properties": { + "resource": { + "id": "userDefinedFunctionName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionList.json new file mode 100644 index 000000000000..964643929034 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBSqlUserDefinedFunctionList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlUserDefinedFunctions/userDefinedFunctionName", + "name": "testctn", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlUserDefinedFunctions", + "properties": { + "resource": { + "id": "testctn", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableBackupInformation.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableBackupInformation.json new file mode 100644 index 000000000000..1f20fb5f8bfa --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableBackupInformation.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "tableName": "tableName1", + "location": { + "location": "North Europe" + } + }, + "responses": { + "200": { + "body": { + "continuousBackupInformation": { + "latestRestorableTimestamp": "2021-02-05T02:40:50Z" + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableCreateUpdate.json new file mode 100644 index 000000000000..4a6a3a4edb70 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableCreateUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "tableName": "tableName", + "createUpdateTableParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/tables", + "location": "West US", + "properties": { + "resource": { + "id": "tableName" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableDelete.json new file mode 100644 index 000000000000..e3f91f2e08bb --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableGet.json new file mode 100644 index 000000000000..4e7c3e6b192a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/tables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableList.json new file mode 100644 index 000000000000..5b59da32a1ab --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-15", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/tables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableMigrateToAutoscale.json new file mode 100644 index 000000000000..269ed0aa99d8 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableMigrateToAutoscale.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableMigrateToManualThroughput.json new file mode 100644 index 000000000000..8cc5ceb150e6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableMigrateToManualThroughput.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": { + "headers": { + "Location": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15", + "Azure-AsyncOperation": "https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2023-11-15" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableThroughputGet.json new file mode 100644 index 000000000000..b1162379de2f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableThroughputGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "instantMaximumThroughput": "10000", + "softAllowedMaximumThroughput": "1000000", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableThroughputUpdate.json new file mode 100644 index 000000000000..539a36816bf8 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBTableThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2023-11-15", + "subscriptionId": "subid", + "tableName": "tableName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/managedCassandra.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/managedCassandra.json new file mode 100644 index 000000000000..a0daf8e2e98c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/managedCassandra.json @@ -0,0 +1,1397 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB - Managed Cassandra", + "description": "Azure Cosmos DB Database Service Managed Cassandra REST API", + "version": "2023-11-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/cassandraClusters": { + "get": { + "operationId": "CassandraClusters_ListBySubscription", + "description": "List all managed Cassandra clusters in this subscription.", + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "CosmosDBManagedCassandraClusterListBySubscription": { + "$ref": "./examples/CosmosDBManagedCassandraClusterListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of managed Cassandra clusters.", + "schema": { + "$ref": "#/definitions/ListClusters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters": { + "get": { + "operationId": "CassandraClusters_ListByResourceGroup", + "description": "List all managed Cassandra clusters in this resource group.", + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "CosmosDBManagedCassandraClusterListByResourceGroup": { + "$ref": "./examples/CosmosDBManagedCassandraClusterListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of managed Cassandra clusters.", + "schema": { + "$ref": "#/definitions/ListClusters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}": { + "get": { + "operationId": "CassandraClusters_Get", + "description": "Get the properties of a managed Cassandra cluster.", + "x-ms-examples": { + "CosmosDBManagedCassandraClusterGet": { + "$ref": "./examples/CosmosDBManagedCassandraClusterGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of the managed Cassandra cluster were retrieved successfully.", + "schema": { + "$ref": "#/definitions/ClusterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "CassandraClusters_Delete", + "description": "Deletes a managed Cassandra cluster.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CosmosDBManagedCassandraClusterDelete": { + "$ref": "./examples/CosmosDBManagedCassandraClusterDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The managed Cassandra cluster will be deleted asynchronously." + }, + "204": { + "description": "No such cluster to delete." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "CassandraClusters_CreateUpdate", + "description": "Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.", + "x-ms-examples": { + "CosmosDBManagedCassandraClusterCreate": { + "$ref": "./examples/CosmosDBManagedCassandraClusterCreate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterResource" + }, + "description": "The properties specifying the desired state of the managed Cassandra cluster." + } + ], + "responses": { + "200": { + "description": "The managed Cassandra cluster is being updated. Poll for provisioningState=Succeeded to find when creation completes.", + "schema": { + "$ref": "#/definitions/ClusterResource" + } + }, + "201": { + "description": "The managed Cassandra cluster is being created. Poll for provisioningState=Succeeded to find when creation completes.", + "schema": { + "$ref": "#/definitions/ClusterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "operationId": "CassandraClusters_Update", + "description": "Updates some of the properties of a managed Cassandra cluster.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CosmosDBManagedCassandraClusterPatch": { + "$ref": "./examples/CosmosDBManagedCassandraClusterPatch.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterResource" + }, + "description": "Parameters to provide for specifying the managed Cassandra cluster." + } + ], + "responses": { + "202": { + "description": "The managed Cassandra cluster is being updated. Poll the provided operation for completion.", + "schema": { + "$ref": "#/definitions/ClusterResource" + } + }, + "200": { + "description": "Completed synchronously. This will only happen if the fields changed by patch require no changes to the actual Cassandra data center.", + "schema": { + "$ref": "#/definitions/ClusterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/invokeCommand": { + "post": { + "operationId": "CassandraClusters_InvokeCommand", + "description": "Invoke a command like nodetool for cassandra maintenance ", + "x-ms-examples": { + "CosmosDBManagedCassandraCommand": { + "$ref": "./examples/CosmosDBManagedCassandraCommand.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CommandPostBody" + }, + "description": "Specification which command to run where" + } + ], + "responses": { + "202": { + "description": "Success. The command operation will begin as soon as possible.", + "schema": { + "$ref": "#/definitions/CommandOutput" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters": { + "get": { + "operationId": "CassandraDataCenters_List", + "description": "List all data centers in a particular managed Cassandra cluster.", + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "CosmosDBManagedCassandraDataCenterList": { + "$ref": "./examples/CosmosDBManagedCassandraDataCenterList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of managed Cassandra data centers.", + "schema": { + "$ref": "#/definitions/ListDataCenters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}": { + "get": { + "operationId": "CassandraDataCenters_Get", + "description": "Get the properties of a managed Cassandra data center.", + "x-ms-examples": { + "CosmosDBManagedCassandraDataCenterGet": { + "$ref": "./examples/CosmosDBManagedCassandraDataCenterGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/dataCenterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The properties of the managed Cassandra data center were retrieved successfully.", + "schema": { + "$ref": "#/definitions/DataCenterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "CassandraDataCenters_Delete", + "description": "Delete a managed Cassandra data center.", + "x-ms-examples": { + "CosmosDBManagedCassandraDataCenterDelete": { + "$ref": "./examples/CosmosDBManagedCassandraDataCenterDelete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/dataCenterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. Deletion will complete asynchronously." + }, + "204": { + "description": "Cassandra cluster with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "CassandraDataCenters_CreateUpdate", + "description": "Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH.", + "x-ms-examples": { + "CosmosDBManagedCassandraDataCenterCreate": { + "$ref": "./examples/CosmosDBManagedCassandraDataCenterCreate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/dataCenterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataCenterResource" + }, + "description": "Parameters specifying the managed Cassandra data center." + } + ], + "responses": { + "201": { + "description": "Accepted. The data center will be created asynchronously.", + "schema": { + "$ref": "#/definitions/DataCenterResource" + } + }, + "200": { + "description": "Accepted. The data center will be updated asynchronously.", + "schema": { + "$ref": "#/definitions/DataCenterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "operationId": "CassandraDataCenters_Update", + "description": "Update some of the properties of a managed Cassandra data center.", + "x-ms-examples": { + "CosmosDBManagedCassandraDataCenterUpdate": { + "$ref": "./examples/CosmosDBManagedCassandraDataCenterPatch.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/dataCenterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataCenterResource" + }, + "description": "Parameters to provide for specifying the managed Cassandra data center." + } + ], + "responses": { + "202": { + "description": "Accepted. Update will proceed asynchronously.", + "schema": { + "$ref": "#/definitions/DataCenterResource" + } + }, + "200": { + "description": "Completed synchronously. This will only happen if the fields changed by patch require no changes to the actual Cassandra cluster, such as editing the tags.", + "schema": { + "$ref": "#/definitions/DataCenterResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/deallocate": { + "post": { + "operationId": "CassandraClusters_Deallocate", + "description": "Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster.", + "x-ms-examples": { + "CosmosDBManagedCassandraClusterDeallocate": { + "$ref": "./examples/CosmosDBManagedCassandraClusterDeallocate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Cluster deallocated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/start": { + "post": { + "operationId": "CassandraClusters_Start", + "description": "Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won't do anything on an already running cluster. Use Deallocate to deallocate the cluster.", + "x-ms-examples": { + "CosmosDBManagedCassandraClusterStart": { + "$ref": "./examples/CosmosDBManagedCassandraClusterStart.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Enqueued Operation to start the cluster." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/status": { + "get": { + "operationId": "CassandraClusters_Status", + "description": "Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.", + "x-ms-examples": { + "CosmosDBManagedCassandraStatus": { + "$ref": "./examples/CosmosDBManagedCassandraStatus.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully fetched the usage statistics of all nodes in the cluster.", + "schema": { + "$ref": "#/definitions/CassandraClusterPublicStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Managed Cassandra cluster name.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$" + }, + "dataCenterNameParameter": { + "name": "dataCenterName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Data center name in a managed Cassandra cluster.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$" + }, + "backupNameParameter": { + "name": "backupId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Id of a restorable backup of a Cassandra cluster.", + "minLength": 1, + "maxLength": 15, + "pattern": "^[0-9]+$" + } + }, + "definitions": { + "ListClusters": { + "description": "List of managed Cassandra clusters.", + "readOnly": true, + "type": "object", + "properties": { + "value": { + "description": "Container for the array of clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterResource" + } + } + } + }, + "ManagedCassandraARMResourceProperties": { + "type": "object", + "description": "The core properties of ARM resources.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "$ref": "cosmos-db.json#/definitions/Tags" + }, + "identity": { + "$ref": "#/definitions/ManagedCassandraManagedServiceIdentity" + } + }, + "x-ms-azure-resource": true + }, + "ManagedCassandraManagedServiceIdentity": { + "description": "Identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The object id of the identity resource." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the resource." + }, + "type": { + "type": "string", + "description": "The type of the resource.", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ManagedCassandraResourceIdentityType", + "modelAsString": true + } + } + } + }, + "ManagedCassandraProvisioningState": { + "description": "The status of the resource at the time the operation was called.", + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ManagedCassandraProvisioningState", + "modelAsString": true + } + }, + "ClusterResource": { + "description": "Representation of a managed Cassandra cluster.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedCassandraARMResourceProperties" + } + ], + "properties": { + "properties": { + "type": "object", + "description": "Properties of a managed Cassandra cluster.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ManagedCassandraProvisioningState" + }, + "restoreFromBackupId": { + "type": "string", + "x-ms-mutability": [ + "create" + ], + "description": "To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup." + }, + "delegatedManagementSubnetId": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "description": "Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'" + }, + "cassandraVersion": { + "type": "string", + "description": "Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version." + }, + "clusterNameOverride": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "description": "If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property." + }, + "authenticationMethod": { + "type": "string", + "description": "Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.", + "enum": [ + "None", + "Cassandra", + "Ldap" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + }, + "initialCassandraAdminPassword": { + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true, + "description": "Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.", + "type": "string" + }, + "prometheusEndpoint": { + "$ref": "#/definitions/SeedNode", + "description": "Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached." + }, + "repairEnabled": { + "type": "boolean", + "description": "Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs." + }, + "clientCertificates": { + "description": "List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.", + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "externalGossipCertificates": { + "description": "List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.", + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "gossipCertificates": { + "readOnly": true, + "x-ms-mutability": [ + "read" + ], + "description": "List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.", + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "externalSeedNodes": { + "type": "array", + "description": "List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.", + "items": { + "$ref": "#/definitions/SeedNode" + } + }, + "seedNodes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SeedNode" + }, + "description": "List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes." + }, + "hoursBetweenBackups": { + "type": "integer", + "format": "int32", + "description": "(Deprecated) Number of hours to wait between taking a backup of the cluster." + }, + "deallocated": { + "type": "boolean", + "description": "Whether the cluster and associated data centers has been deallocated." + }, + "cassandraAuditLoggingEnabled": { + "type": "boolean", + "description": "Whether Cassandra audit logging is enabled" + }, + "provisionError": { + "$ref": "#/definitions/CassandraError", + "description": "Error related to resource provisioning." + } + } + } + } + }, + "ManagedCassandraNodeStatus": { + "type": "string", + "description": "Indicates whether the node is functioning or not.", + "enum": [ + "Up", + "Down" + ], + "x-ms-enum": { + "name": "NodeStatus", + "modelAsString": true + } + }, + "ManagedCassandraNodeState": { + "type": "string", + "description": "The state of the node in Cassandra ring.", + "enum": [ + "Normal", + "Leaving", + "Joining", + "Moving", + "Stopped" + ], + "x-ms-enum": { + "name": "NodeState", + "modelAsString": true + } + }, + "CassandraClusterPublicStatus": { + "type": "object", + "description": "Properties of a managed Cassandra cluster public status.", + "properties": { + "eTag": { + "type": "string" + }, + "reaperStatus": { + "$ref": "#/definitions/ManagedCassandraReaperStatus" + }, + "connectionErrors": { + "type": "array", + "description": "List relevant information about any connection errors to the Datacenters.", + "items": { + "$ref": "#/definitions/ConnectionError" + } + }, + "errors": { + "type": "array", + "description": "List relevant information about any errors about cluster, data center and connection error.", + "items": { + "$ref": "#/definitions/CassandraError" + } + }, + "dataCenters": { + "type": "array", + "description": "List of the status of each datacenter in this cluster.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of this Datacenter." + }, + "seedNodes": { + "type": "array", + "description": "A list of all seed nodes in the cluster, managed and unmanaged.", + "items": { + "type": "string" + } + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string", + "description": "The node's IP address." + }, + "state": { + "$ref": "#/definitions/ManagedCassandraNodeState" + }, + "status": { + "type": "string" + }, + "cassandraProcessStatus": { + "type": "string", + "description": "Cassandra service status on this node" + }, + "load": { + "type": "string", + "description": "The amount of file system data in the data directory (e.g., 47.66 kB), excluding all content in the snapshots subdirectories. Because all SSTable data files are included, any data that is not cleaned up (such as TTL-expired cells or tombstones) is counted." + }, + "tokens": { + "type": "array", + "description": "List of tokens this node covers.", + "items": { + "type": "string" + } + }, + "size": { + "type": "integer", + "format": "int32" + }, + "hostID": { + "description": "The network ID of the node.", + "type": "string" + }, + "rack": { + "description": "The rack this node is part of.", + "type": "string" + }, + "timestamp": { + "description": "The timestamp when these statistics were captured.", + "type": "string" + }, + "diskUsedKB": { + "description": "The amount of disk used, in kB, of the directory /var/lib/cassandra.", + "type": "integer", + "format": "int64" + }, + "diskFreeKB": { + "description": "The amount of disk free, in kB, of the directory /var/lib/cassandra.", + "type": "integer", + "format": "int64" + }, + "memoryUsedKB": { + "description": "Used memory (calculated as total - free - buffers - cache), in kB.", + "type": "integer", + "format": "int64" + }, + "memoryBuffersAndCachedKB": { + "description": "Memory used by kernel buffers (Buffers in /proc/meminfo) and page cache and slabs (Cached and SReclaimable in /proc/meminfo), in kB.", + "type": "integer", + "format": "int64" + }, + "memoryFreeKB": { + "description": "Unused memory (MemFree and SwapFree in /proc/meminfo), in kB.", + "type": "integer", + "format": "int64" + }, + "memoryTotalKB": { + "description": "Total installed memory (MemTotal and SwapTotal in /proc/meminfo), in kB.", + "type": "integer", + "format": "int64" + }, + "cpuUsage": { + "description": "A float representing the current system-wide CPU utilization as a percentage.", + "type": "number", + "format": "double" + } + } + } + } + } + } + } + } + }, + "ManagedCassandraReaperStatus": { + "type": "object", + "properties": { + "healthy": { + "type": "boolean" + }, + "repairRunIds": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repairSchedules": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ConnectionError": { + "type": "object", + "properties": { + "connectionState": { + "description": "The kind of connection error that occurred.", + "type": "string", + "enum": [ + "Unknown", + "OK", + "OperatorToDataCenterNetworkError", + "DatacenterToDatacenterNetworkError", + "InternalOperatorToDataCenterCertificateError", + "InternalError" + ], + "x-ms-enum": { + "name": "ConnectionState", + "modelAsString": true + } + }, + "iPFrom": { + "description": "The IP of host that originated the failed connection.", + "type": "string" + }, + "iPTo": { + "description": "The IP that the connection attempted to reach.", + "type": "string" + }, + "port": { + "description": "The TCP port the connection was attempted on.", + "type": "integer", + "format": "int32" + }, + "exception": { + "description": "Detailed error message about the failed connection.", + "type": "string" + } + } + }, + "CassandraError": { + "type": "object", + "properties": { + "code": { + "description": "The code of error that occurred.", + "type": "string" + }, + "message": { + "description": "The message of the error.", + "type": "string" + }, + "target": { + "description": "The target resource of the error.", + "type": "string" + }, + "additionalErrorInfo": { + "description": "Additional information about the error.", + "type": "string" + } + } + }, + "CommandPostBody": { + "description": "Specification of which command to run where", + "type": "object", + "required": [ + "command", + "host" + ], + "properties": { + "command": { + "type": "string", + "description": "The command which should be run" + }, + "arguments": { + "type": "object", + "description": "The arguments for the command to be run", + "additionalProperties": { + "type": "string" + } + }, + "host": { + "type": "string", + "description": "IP address of the cassandra host to run the command on" + }, + "cassandra-stop-start": { + "type": "boolean", + "description": "If true, stops cassandra before executing the command and then start it again" + }, + "readwrite": { + "type": "boolean", + "description": "If true, allows the command to *write* to the cassandra directory, otherwise read-only." + } + } + }, + "CommandOutput": { + "description": "Response of /command api", + "type": "object", + "properties": { + "commandOutput": { + "type": "string", + "description": "Output of the command." + } + } + }, + "ListDataCenters": { + "description": "List of managed Cassandra data centers and their properties.", + "type": "object", + "properties": { + "value": { + "description": "Container for array of data centers.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DataCenterResource" + } + } + } + }, + "SeedNode": { + "type": "object", + "properties": { + "ipAddress": { + "description": "IP address of this seed node.", + "type": "string" + } + } + }, + "Certificate": { + "type": "object", + "properties": { + "pem": { + "description": "PEM formatted public key.", + "type": "string" + } + } + }, + "DataCenterResource": { + "description": "A managed Cassandra data center.", + "type": "object", + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "properties": { + "properties": { + "description": "Properties of a managed Cassandra data center.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ManagedCassandraProvisioningState" + }, + "dataCenterLocation": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "description": "The region this data center should be created in." + }, + "delegatedSubnetId": { + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ], + "description": "Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'." + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster." + }, + "seedNodes": { + "readOnly": true, + "type": "array", + "description": "IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster.", + "items": { + "$ref": "#/definitions/SeedNode" + } + }, + "base64EncodedCassandraYamlFragment": { + "type": "string", + "description": "A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed." + }, + "managedDiskCustomerKeyUri": { + "type": "string", + "description": "Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key." + }, + "backupStorageCustomerKeyUri": { + "type": "string", + "description": "Indicates the Key Uri of the customer key to use for encryption of the backup storage account." + }, + "sku": { + "type": "string", + "description": "Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2" + }, + "diskSku": { + "type": "string", + "description": "Disk SKU used for data centers. Default value is P30." + }, + "diskCapacity": { + "type": "integer", + "format": "int32", + "description": "Number of disks attached to each node. Default is 4." + }, + "availabilityZone": { + "type": "boolean", + "description": "If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines." + }, + "authenticationMethodLdapProperties": { + "$ref": "#/definitions/AuthenticationMethodLdapProperties" + }, + "deallocated": { + "type": "boolean", + "description": "Whether the data center has been deallocated." + }, + "provisionError": { + "$ref": "#/definitions/CassandraError", + "description": "Error related to resource provisioning." + } + } + } + } + }, + "AuthenticationMethodLdapProperties": { + "type": "object", + "description": "Ldap authentication method properties. This feature is in preview.", + "properties": { + "serverHostname": { + "description": "Hostname of the LDAP server.", + "type": "string" + }, + "serverPort": { + "description": "Port of the LDAP server.", + "type": "integer", + "format": "int32" + }, + "serviceUserDistinguishedName": { + "description": "Distinguished name of the look up user account, who can look up user details on authentication.", + "type": "string" + }, + "serviceUserPassword": { + "description": "Password of the look up user.", + "type": "string" + }, + "searchBaseDistinguishedName": { + "description": "Distinguished name of the object to start the recursive search of users from.", + "type": "string" + }, + "searchFilterTemplate": { + "description": "Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.", + "type": "string" + }, + "serverCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "connectionTimeoutInMs": { + "description": "Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.", + "type": "integer", + "format": "int32" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/mongorbac.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/mongorbac.json new file mode 100644 index 000000000000..b4ca66a9cebf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/mongorbac.json @@ -0,0 +1,616 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB API for MongoDB Role Based Access Control Resource Provider REST API", + "version": "2023-11-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions/{mongoRoleDefinitionId}": { + "get": { + "operationId": "MongoDBResources_GetMongoRoleDefinition", + "x-ms-examples": { + "CosmosDBMongoRoleDefinitionGet": { + "$ref": "./examples/CosmosDBMongoDBRoleDefinitionGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.", + "parameters": [ + { + "$ref": "#/parameters/mongoRoleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Mongo Role Definition was successfully retrieved.", + "schema": { + "$ref": "#/definitions/MongoRoleDefinitionGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_CreateUpdateMongoRoleDefinition", + "x-ms-examples": { + "CosmosDBMongoDBRoleDefinitionCreateUpdate": { + "$ref": "./examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates or updates an Azure Cosmos DB Mongo Role Definition.", + "parameters": [ + { + "$ref": "#/parameters/mongoRoleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateMongoRoleDefinitionParameters", + "in": "body", + "required": true, + "description": "The properties required to create or update a Role Definition.", + "schema": { + "$ref": "#/definitions/MongoRoleDefinitionCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Mongo Role Definition create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/MongoRoleDefinitionGetResults" + } + }, + "202": { + "description": "The Mongo Role Definition create or update request was accepted and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "MongoDBResources_DeleteMongoRoleDefinition", + "x-ms-examples": { + "CosmosDBMongoDBRoleDefinitionDelete": { + "$ref": "./examples/CosmosDBMongoDBRoleDefinitionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes an existing Azure Cosmos DB Mongo Role Definition.", + "parameters": [ + { + "$ref": "#/parameters/mongoRoleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Mongo Role Definition delete operation was completed successfully." + }, + "202": { + "description": "The Mongo Role Definition delete request was accepted and will complete asynchronously." + }, + "204": { + "description": "The requested Mongo Role Definition does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbRoleDefinitions": { + "get": { + "operationId": "MongoDBResources_ListMongoRoleDefinitions", + "x-ms-examples": { + "CosmosDBMongoDBRoleDefinitionList": { + "$ref": "./examples/CosmosDBMongoDBRoleDefinitionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the list of all Azure Cosmos DB Mongo Role Definitions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list operation completed successfully.", + "schema": { + "$ref": "#/definitions/MongoRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId}": { + "get": { + "operationId": "MongoDBResources_GetMongoUserDefinition", + "x-ms-examples": { + "CosmosDBMongoDBUserDefinitionGet": { + "$ref": "./examples/CosmosDBMongoDBUserDefinitionGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.", + "parameters": [ + { + "$ref": "#/parameters/mongoUserDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The User Definition was successfully retrieved.", + "schema": { + "$ref": "#/definitions/MongoUserDefinitionGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_CreateUpdateMongoUserDefinition", + "x-ms-examples": { + "CosmosDBMongoDBUserDefinitionCreateUpdate": { + "$ref": "./examples/CosmosDBMongoDBUserDefinitionCreateUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates or updates an Azure Cosmos DB Mongo User Definition.", + "parameters": [ + { + "$ref": "#/parameters/mongoUserDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateMongoUserDefinitionParameters", + "in": "body", + "required": true, + "description": "The properties required to create or update a User Definition.", + "schema": { + "$ref": "#/definitions/MongoUserDefinitionCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The User Definition create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/MongoUserDefinitionGetResults" + } + }, + "202": { + "description": "The User Definition create or update request was accepted and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "MongoDBResources_DeleteMongoUserDefinition", + "x-ms-examples": { + "CosmosDBMongoDBUserDefinitionDelete": { + "$ref": "./examples/CosmosDBMongoDBUserDefinitionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes an existing Azure Cosmos DB Mongo User Definition.", + "parameters": [ + { + "$ref": "#/parameters/mongoUserDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The User Definition delete operation was completed successfully." + }, + "202": { + "description": "The User Definition delete request was accepted and will complete asynchronously." + }, + "204": { + "description": "The requested User Definition does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions": { + "get": { + "operationId": "MongoDBResources_ListMongoUserDefinitions", + "x-ms-examples": { + "CosmosDBMongoDBUserDefinitionList": { + "$ref": "./examples/CosmosDBMongoDBUserDefinitionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the list of all Azure Cosmos DB Mongo User Definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list operation completed successfully.", + "schema": { + "$ref": "#/definitions/MongoUserDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "MongoRoleDefinitionResource": { + "type": "object", + "properties": { + "roleName": { + "type": "string", + "description": "A user-friendly name for the Role Definition. Must be unique for the database account." + }, + "type": { + "type": "string", + "enum": [ + "BuiltInRole", + "CustomRole" + ], + "description": "Indicates whether the Role Definition was built-in or user created.", + "x-ms-enum": { + "name": "MongoRoleDefinitionType", + "modelAsString": false + } + }, + "databaseName": { + "type": "string", + "description": "The database name for which access is being granted for this Role Definition." + }, + "privileges": { + "type": "array", + "items": { + "$ref": "#/definitions/Privilege" + }, + "description": "A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege." + }, + "roles": { + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "description": "The set of roles inherited by this Role Definition." + } + }, + "description": "Azure Cosmos DB Mongo Role Definition resource object." + }, + "MongoRoleDefinitionCreateUpdateParameters": { + "description": "Parameters to create and update an Azure Cosmos DB Mongo Role Definition.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update an Azure Cosmos DB Mongo Role Definition.", + "$ref": "#/definitions/MongoRoleDefinitionResource" + } + } + }, + "MongoRoleDefinitionGetResults": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoRoleDefinitionResource", + "description": "Properties related to the Mongo Role Definition." + } + }, + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "description": "An Azure Cosmos DB Mongo Role Definition." + }, + "Privilege": { + "type": "object", + "properties": { + "resource": { + "type": "object", + "properties": { + "db": { + "type": "string", + "description": "The database name the role is applied." + }, + "collection": { + "type": "string", + "description": "The collection name the role is applied." + } + }, + "description": "An Azure Cosmos DB Mongo DB Resource." + }, + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of actions that are allowed." + } + }, + "description": "The set of data plane operations permitted through this Role Definition." + }, + "Role": { + "type": "object", + "properties": { + "db": { + "type": "string", + "description": "The database name the role is applied." + }, + "role": { + "type": "string", + "description": "The role name." + } + }, + "description": "The set of roles permitted through this Role Definition." + }, + "MongoRoleDefinitionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MongoRoleDefinitionGetResults" + }, + "description": "List of Mongo Role Definitions and their properties." + } + }, + "description": "The relevant Mongo Role Definitions." + }, + "MongoUserDefinitionResource": { + "type": "object", + "properties": { + "userName": { + "type": "string", + "description": "The user name for User Definition." + }, + "password": { + "type": "string", + "description": "The password for User Definition. Response does not contain user password." + }, + "databaseName": { + "type": "string", + "description": "The database name for which access is being granted for this User Definition." + }, + "customData": { + "type": "string", + "description": "A custom definition for the USer Definition." + }, + "roles": { + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "description": "The set of roles inherited by the User Definition." + }, + "mechanisms": { + "type": "string", + "description": "The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256." + } + }, + "description": "Azure Cosmos DB Mongo User Definition resource object." + }, + "MongoUserDefinitionCreateUpdateParameters": { + "description": "Parameters to create and update an Azure Cosmos DB Mongo User Definition.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update an Azure Cosmos DB Mongo User Definition.", + "$ref": "#/definitions/MongoUserDefinitionResource" + } + } + }, + "MongoUserDefinitionGetResults": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoUserDefinitionResource", + "description": "Properties related to the User Definition." + } + }, + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "description": "An Azure Cosmos DB User Definition" + }, + "MongoUserDefinitionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MongoUserDefinitionGetResults" + }, + "description": "List of User Definition and their properties" + } + }, + "description": "The relevant User Definition." + } + }, + "parameters": { + "mongoRoleDefinitionIdParameter": { + "name": "mongoRoleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The ID for the Role Definition {dbName.roleName}." + }, + "mongoUserDefinitionIdParameter": { + "name": "mongoUserDefinitionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The ID for the User Definition {dbName.userName}." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/notebook.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/notebook.json new file mode 100644 index 000000000000..7151b2f68c9b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/notebook.json @@ -0,0 +1,461 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2023-11-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces": { + "get": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Gets the notebook workspace resources of an existing Cosmos DB account.", + "operationId": "NotebookWorkspaces_ListByDatabaseAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved notebook workspace resources.", + "schema": { + "$ref": "#/definitions/NotebookWorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceList": { + "$ref": "./examples/CosmosDBNotebookWorkspaceList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}": { + "get": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Gets the notebook workspace for a Cosmos DB account.", + "operationId": "NotebookWorkspaces_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified notebook workspace resource.", + "schema": { + "$ref": "#/definitions/NotebookWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceGet": { + "$ref": "./examples/CosmosDBNotebookWorkspaceGet.json" + } + } + }, + "put": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Creates the notebook workspace for a Cosmos DB account.", + "operationId": "NotebookWorkspaces_CreateOrUpdate", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + }, + { + "name": "notebookCreateUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NotebookWorkspaceCreateUpdateParameters" + }, + "description": "The notebook workspace to create for the current database account." + } + ], + "responses": { + "200": { + "description": "Creation of notebook workspace will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NotebookWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceCreate": { + "$ref": "./examples/CosmosDBNotebookWorkspaceCreate.json" + } + } + }, + "delete": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Deletes the notebook workspace for a Cosmos DB account.", + "operationId": "NotebookWorkspaces_Delete", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "202": { + "description": "The notebook workspace delete operation will complete asynchronously." + }, + "204": { + "description": "The specified notebook workspace does not exist in the database account." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceDelete": { + "$ref": "./examples/CosmosDBNotebookWorkspaceDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/listConnectionInfo": { + "post": { + "tags": [ + "NotebookWorkspacesResource" + ], + "operationId": "NotebookWorkspaces_ListConnectionInfo", + "x-ms-examples": { + "CosmosDBNotebookWorkspaceListConnectionInfo": { + "$ref": "./examples/CosmosDBNotebookWorkspaceListConnectionInfo.json" + } + }, + "description": "Retrieves the connection info for the notebook workspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NotebookWorkspaceConnectionInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/regenerateAuthToken": { + "post": { + "tags": [ + "NotebookWorkspacesResource" + ], + "operationId": "NotebookWorkspaces_RegenerateAuthToken", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceRegenerateAuthToken": { + "$ref": "./examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json" + } + }, + "description": "Regenerates the auth token for the notebook workspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The regenerate auth token operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/start": { + "post": { + "tags": [ + "NotebookWorkspacesResource" + ], + "operationId": "NotebookWorkspaces_Start", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceStart": { + "$ref": "./examples/CosmosDBNotebookWorkspaceStart.json" + } + }, + "description": "Starts the notebook workspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The start operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "NotebookWorkspaceCreateUpdateParameters": { + "description": "Parameters to create a notebook workspace resource", + "type": "object", + "allOf": [ + { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ARMProxyResource" + } + ] + }, + "NotebookWorkspaceListResult": { + "description": "A list of notebook workspace resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of notebook workspace resources", + "items": { + "$ref": "#/definitions/NotebookWorkspace" + } + } + } + }, + "NotebookWorkspace": { + "description": "A notebook workspace resource", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/NotebookWorkspaceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ARMProxyResource" + } + ] + }, + "NotebookWorkspaceProperties": { + "description": "Properties of a notebook workspace resource.", + "type": "object", + "properties": { + "notebookServerEndpoint": { + "description": "Specifies the endpoint of Notebook server.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.", + "type": "string", + "readOnly": true + } + } + }, + "NotebookWorkspaceConnectionInfoResult": { + "description": "The connection info for the given notebook workspace", + "properties": { + "authToken": { + "type": "string", + "description": "Specifies auth token used for connecting to Notebook server (uses token-based auth).", + "readOnly": true + }, + "notebookServerEndpoint": { + "type": "string", + "description": "Specifies the endpoint of Notebook server.", + "readOnly": true + } + } + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "NotebookWorkspaceNameParameter": { + "name": "notebookWorkspaceName", + "in": "path", + "description": "The name of the notebook workspace resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "NotebookWorkspaceName", + "modelAsString": true + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/privateEndpointConnection.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/privateEndpointConnection.json new file mode 100644 index 000000000000..76aa94a61e95 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/privateEndpointConnection.json @@ -0,0 +1,318 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2023-11-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List all private endpoint connections on a Cosmos DB account.", + "operationId": "PrivateEndpointConnections_ListByDatabaseAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/CosmosDBPrivateEndpointConnectionListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/CosmosDBPrivateEndpointConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted. The private endpoint connection update will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Approve or reject a private endpoint connection with a given name.": { + "$ref": "./examples/CosmosDBPrivateEndpointConnectionUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The private endpoint connection delete will complete asynchronously." + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/CosmosDBPrivateEndpointConnectionDelete.json" + } + } + } + } + }, + "definitions": { + "PrivateEndpointConnectionListResult": { + "description": "A list of private endpoint connections", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "Properties of a private endpoint connection.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpointProperty", + "description": "Private endpoint which the connection belongs to." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty", + "description": "Connection State of the Private Endpoint Connection." + }, + "groupId": { + "type": "string", + "description": "Group id of the private endpoint." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the private endpoint." + } + } + }, + "PrivateEndpointProperty": { + "type": "object", + "description": "Private endpoint which the connection belongs to.", + "properties": { + "id": { + "type": "string", + "description": "Resource id of the private endpoint." + } + } + }, + "PrivateLinkServiceConnectionStateProperty": { + "type": "object", + "description": "Connection State of the Private Endpoint Connection.", + "properties": { + "status": { + "type": "string", + "description": "The private link service connection status." + }, + "description": { + "type": "string", + "description": "The private link service connection description." + }, + "actionsRequired": { + "type": "string", + "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)", + "readOnly": true + } + } + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the private endpoint connection." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/privateLinkResources.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/privateLinkResources.json new file mode 100644 index 000000000000..7319dbca22d2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/privateLinkResources.json @@ -0,0 +1,195 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2023-11-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Cosmos DB account.", + "operationId": "PrivateLinkResources_ListByDatabaseAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/CosmosDBPrivateLinkResourceListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Cosmos DB account.", + "operationId": "PrivateLinkResources_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/GroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private link resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/CosmosDBPrivateLinkResourceGet.json" + } + } + } + } + }, + "definitions": { + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ARMProxyResource" + } + ] + }, + "PrivateLinkResourceProperties": { + "description": "Properties of a private link resource.", + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "description": "The private link resource required zone names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "GroupNameParameter": { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/rbac.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/rbac.json new file mode 100644 index 000000000000..6d6b2a546538 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/rbac.json @@ -0,0 +1,573 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Role Based Access Control Resource Provider REST API", + "version": "2023-11-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}": { + "get": { + "operationId": "SqlResources_GetSqlRoleDefinition", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionGet": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.", + "parameters": [ + { + "$ref": "#/parameters/roleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Definition was successfully retrieved.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlRoleDefinition", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionCreateUpdate": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionCreateUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates or updates an Azure Cosmos DB SQL Role Definition.", + "parameters": [ + { + "$ref": "#/parameters/roleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlRoleDefinitionParameters", + "in": "body", + "required": true, + "description": "The properties required to create or update a Role Definition.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Role Definition create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionGetResults" + } + }, + "202": { + "description": "The Role Definition create or update request was accepted and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlRoleDefinition", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionDelete": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes an existing Azure Cosmos DB SQL Role Definition.", + "parameters": [ + { + "$ref": "#/parameters/roleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Definition delete operation was completed successfully." + }, + "202": { + "description": "The Role Definition delete request was accepted and will complete asynchronously." + }, + "204": { + "description": "The requested Role Definition does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions": { + "get": { + "operationId": "SqlResources_ListSqlRoleDefinitions", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionList": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the list of all Azure Cosmos DB SQL Role Definitions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}": { + "get": { + "operationId": "SqlResources_GetSqlRoleAssignment", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentGet": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.", + "parameters": [ + { + "$ref": "#/parameters/roleAssignmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Assignment was successfully retrieved.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlRoleAssignment", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentCreateUpdate": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentCreateUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates or updates an Azure Cosmos DB SQL Role Assignment.", + "parameters": [ + { + "$ref": "#/parameters/roleAssignmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlRoleAssignmentParameters", + "in": "body", + "required": true, + "description": "The properties required to create or update a Role Assignment.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Role Assignment create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentGetResults" + } + }, + "202": { + "description": "The Role Assignment create or update request was accepted and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlRoleAssignment", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentDelete": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes an existing Azure Cosmos DB SQL Role Assignment.", + "parameters": [ + { + "$ref": "#/parameters/roleAssignmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Assignment delete operation was completed successfully." + }, + "202": { + "description": "The Role Assignment delete request was accepted and will complete asynchronously." + }, + "204": { + "description": "The requested Role Assignment does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments": { + "get": { + "operationId": "SqlResources_ListSqlRoleAssignments", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentList": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the list of all Azure Cosmos DB SQL Role Assignments.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "SqlRoleDefinitionResource": { + "properties": { + "roleName": { + "type": "string", + "description": "A user-friendly name for the Role Definition. Must be unique for the database account." + }, + "type": { + "type": "string", + "enum": [ + "BuiltInRole", + "CustomRole" + ], + "description": "Indicates whether the Role Definition was built-in or user created.", + "x-ms-enum": { + "name": "RoleDefinitionType", + "modelAsString": false + } + }, + "assignableScopes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist." + }, + "permissions": { + "type": "array", + "items": { + "$ref": "#/definitions/Permission" + }, + "description": "The set of operations allowed through this Role Definition." + } + }, + "description": "Azure Cosmos DB SQL Role Definition resource object." + }, + "SqlRoleDefinitionCreateUpdateParameters": { + "description": "Parameters to create and update an Azure Cosmos DB SQL Role Definition.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update an Azure Cosmos DB SQL Role Definition.", + "$ref": "#/definitions/SqlRoleDefinitionResource" + } + } + }, + "SqlRoleDefinitionGetResults": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlRoleDefinitionResource", + "description": "Properties related to the Role Definition." + } + }, + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "description": "An Azure Cosmos DB SQL Role Definition." + }, + "Permission": { + "type": "object", + "properties": { + "dataActions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of data actions that are allowed." + }, + "notDataActions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of data actions that are denied." + } + }, + "description": "The set of data plane operations permitted through this Role Definition." + }, + "SqlRoleDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SqlRoleDefinitionGetResults" + }, + "description": "List of Role Definitions and their properties." + } + }, + "description": "The relevant Role Definitions." + }, + "SqlRoleAssignmentResource": { + "type": "object", + "properties": { + "roleDefinitionId": { + "type": "string", + "description": "The unique identifier for the associated Role Definition." + }, + "scope": { + "type": "string", + "description": "The data plane resource path for which access is being granted through this Role Assignment." + }, + "principalId": { + "type": "string", + "description": "The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription." + } + }, + "description": "Azure Cosmos DB SQL Role Assignment resource object." + }, + "SqlRoleAssignmentCreateUpdateParameters": { + "description": "Parameters to create and update an Azure Cosmos DB SQL Role Assignment.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update an Azure Cosmos DB SQL Role Assignment.", + "$ref": "#/definitions/SqlRoleAssignmentResource" + } + } + }, + "SqlRoleAssignmentGetResults": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlRoleAssignmentResource", + "description": "Properties related to the Role Assignment." + } + }, + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "description": "An Azure Cosmos DB Role Assignment" + }, + "SqlRoleAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SqlRoleAssignmentGetResults" + }, + "description": "List of Role Assignments and their properties" + } + }, + "description": "The relevant Role Assignments." + } + }, + "parameters": { + "roleDefinitionIdParameter": { + "name": "roleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The GUID for the Role Definition." + }, + "roleAssignmentIdParameter": { + "name": "roleAssignmentId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The GUID for the Role Assignment." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/restorable.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/restorable.json new file mode 100644 index 000000000000..fe10d9033531 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/restorable.json @@ -0,0 +1,2074 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2023-11-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts": { + "get": { + "operationId": "RestorableDatabaseAccounts_ListByLocation", + "x-ms-examples": { + "CosmosDBRestorableDatabaseAccountList": { + "$ref": "./examples/CosmosDBRestorableDatabaseAccountList.json" + } + }, + "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableDatabaseAccountsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/restorableDatabaseAccounts": { + "get": { + "operationId": "RestorableDatabaseAccounts_List", + "x-ms-examples": { + "CosmosDBRestorableDatabaseAccountNoLocationList": { + "$ref": "./examples/CosmosDBRestorableDatabaseAccountNoLocationList.json" + } + }, + "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableDatabaseAccountsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}": { + "get": { + "operationId": "RestorableDatabaseAccounts_GetByLocation", + "x-ms-examples": { + "CosmosDBRestorableDatabaseAccountGet": { + "$ref": "./examples/CosmosDBRestorableDatabaseAccountGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB restorable database account. This call requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/read/*' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The restorable database account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/RestorableDatabaseAccountGetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/retrieveContinuousBackupInformation": { + "post": { + "operationId": "SqlResources_RetrieveContinuousBackupInformation", + "x-ms-examples": { + "CosmosDBSqlContainerBackupInformation": { + "$ref": "./examples/CosmosDBSqlContainerBackupInformation.json" + } + }, + "description": "Retrieves continuous backup information for a container resource.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/databaseNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "location", + "required": true, + "description": "The name of the continuous backup restore location.", + "schema": { + "$ref": "#/definitions/ContinuousBackupRestoreLocation" + } + } + ], + "responses": { + "200": { + "description": "The Sql container retrieve backup information operation completed successfully.", + "schema": { + "$ref": "#/definitions/BackupInformation" + } + }, + "202": { + "description": "The sql container retrieve backup information operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlDatabases": { + "get": { + "operationId": "RestorableSqlDatabases_List", + "x-ms-examples": { + "CosmosDBRestorableSqlDatabaseList": { + "$ref": "./examples/CosmosDBRestorableSqlDatabaseList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB SQL databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableSqlDatabasesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers": { + "get": { + "operationId": "RestorableSqlContainers_List", + "x-ms-examples": { + "CosmosDBRestorableSqlContainerList": { + "$ref": "./examples/CosmosDBRestorableSqlContainerList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB SQL containers under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restorableSqlDatabaseRidParameter" + }, + { + "$ref": "#/parameters/restorableSqlContainersEventFeedStartTime" + }, + { + "$ref": "#/parameters/restorableSqlContainersEventFeedEndTime" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableSqlContainersListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources": { + "get": { + "operationId": "RestorableSqlResources_List", + "x-ms-examples": { + "CosmosDBRestorableSqlResourceList": { + "$ref": "./examples/CosmosDBRestorableSqlResourceList.json" + } + }, + "description": "Return a list of database and container combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restoreLocationParameter" + }, + { + "$ref": "#/parameters/restoreTimestampInUtcParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableSqlResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/retrieveContinuousBackupInformation": { + "post": { + "operationId": "MongoDBResources_RetrieveContinuousBackupInformation", + "x-ms-examples": { + "CosmosDBMongoDBCollectionBackupInformation": { + "$ref": "./examples/CosmosDBMongoDBCollectionBackupInformation.json" + } + }, + "description": "Retrieves continuous backup information for a Mongodb collection.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/databaseNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "location", + "required": true, + "description": "The name of the continuous backup restore location.", + "schema": { + "$ref": "#/definitions/ContinuousBackupRestoreLocation" + } + } + ], + "responses": { + "200": { + "description": "The Mongodb collection retrieve backup information operation completed successfully.", + "schema": { + "$ref": "#/definitions/BackupInformation" + } + }, + "202": { + "description": "The Mongodb collection retrieve backup information operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbDatabases": { + "get": { + "operationId": "RestorableMongodbDatabases_List", + "x-ms-examples": { + "CosmosDBRestorableMongodbDatabaseList": { + "$ref": "./examples/CosmosDBRestorableMongodbDatabaseList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableMongodbDatabasesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbCollections": { + "get": { + "operationId": "RestorableMongodbCollections_List", + "x-ms-examples": { + "CosmosDBRestorableMongodbCollectionList": { + "$ref": "./examples/CosmosDBRestorableMongodbCollectionList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restorableMongodbDatabaseRidParameter" + }, + { + "$ref": "#/parameters/restorableMongoDBCollectionsEventFeedStartTime" + }, + { + "$ref": "#/parameters/restorableMongoDBCollectionsEventFeedEndTime" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableMongodbCollectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbResources": { + "get": { + "operationId": "RestorableMongodbResources_List", + "x-ms-examples": { + "CosmosDBRestorableMongodbResourceList": { + "$ref": "./examples/CosmosDBRestorableMongodbResourceList.json" + } + }, + "description": "Return a list of database and collection combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restoreLocationParameter" + }, + { + "$ref": "#/parameters/restoreTimestampInUtcParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableMongodbResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/retrieveContinuousBackupInformation": { + "post": { + "operationId": "GremlinResources_RetrieveContinuousBackupInformation", + "x-ms-examples": { + "CosmosDBGremlinGraphBackupInformation": { + "$ref": "./examples/CosmosDBGremlinGraphBackupInformation.json" + } + }, + "description": "Retrieves continuous backup information for a gremlin graph.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/databaseNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "location", + "required": true, + "description": "The name of the continuous backup restore location.", + "schema": { + "$ref": "#/definitions/ContinuousBackupRestoreLocation" + } + } + ], + "responses": { + "200": { + "description": "The Gremlin graph retrieve backup information operation completed successfully.", + "schema": { + "$ref": "#/definitions/BackupInformation" + } + }, + "202": { + "description": "The Gremlin graph retrieve backup information operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinDatabases": { + "get": { + "operationId": "RestorableGremlinDatabases_List", + "x-ms-examples": { + "CosmosDBRestorableGremlinDatabaseList": { + "$ref": "./examples/CosmosDBRestorableGremlinDatabaseList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin databases under the restorable account. This helps in scenario where database was accidentally deleted to get the deletion time. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableGremlinDatabasesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGraphs": { + "get": { + "operationId": "RestorableGremlinGraphs_List", + "x-ms-examples": { + "CosmosDBRestorableGremlinGraphList": { + "$ref": "./examples/CosmosDBRestorableGremlinGraphList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB Gremlin graphs under a specific database. This helps in scenario where container was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restorableGremlinDatabaseRidParameter" + }, + { + "$ref": "#/parameters/restorableGremlinGraphsEventFeedStartTime" + }, + { + "$ref": "#/parameters/restorableGremlinGraphsEventFeedEndTime" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableGremlinGraphsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableGremlinResources": { + "get": { + "operationId": "RestorableGremlinResources_List", + "x-ms-examples": { + "CosmosDBRestorableGremlinResourceList": { + "$ref": "./examples/CosmosDBRestorableGremlinResourceList.json" + } + }, + "description": "Return a list of gremlin database and graphs combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restoreLocationParameter" + }, + { + "$ref": "#/parameters/restoreTimestampInUtcParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableGremlinResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/retrieveContinuousBackupInformation": { + "post": { + "operationId": "TableResources_RetrieveContinuousBackupInformation", + "x-ms-examples": { + "CosmosDBTableCollectionBackupInformation": { + "$ref": "./examples/CosmosDBTableBackupInformation.json" + } + }, + "description": "Retrieves continuous backup information for a table.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "location", + "required": true, + "description": "The name of the continuous backup restore location.", + "schema": { + "$ref": "#/definitions/ContinuousBackupRestoreLocation" + } + } + ], + "responses": { + "200": { + "description": "The Table retrieve backup information operation completed successfully.", + "schema": { + "$ref": "#/definitions/BackupInformation" + } + }, + "202": { + "description": "The Table retrieve backup information operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableTables": { + "get": { + "operationId": "RestorableTables_List", + "x-ms-examples": { + "CosmosDBRestorableTableList": { + "$ref": "./examples/CosmosDBRestorableTableList.json" + } + }, + "description": "Show the event feed of all mutations done on all the Azure Cosmos DB Tables. This helps in scenario where table was accidentally deleted. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restorableTablesEventFeedStartTime" + }, + { + "$ref": "#/parameters/restorableTablesEventFeedEndTime" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableTablesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableTableResources": { + "get": { + "operationId": "RestorableTableResources_List", + "x-ms-examples": { + "CosmosDBRestorableTableResourceList": { + "$ref": "./examples/CosmosDBRestorableTableResourceList.json" + } + }, + "description": "Return a list of tables that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + }, + { + "$ref": "#/parameters/restoreLocationParameter" + }, + { + "$ref": "#/parameters/restoreTimestampInUtcParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableTableResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "RestorableDatabaseAccountsListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableDatabaseAccountGetResult" + }, + "description": "List of restorable database accounts and their properties." + } + }, + "description": "The List operation response, that contains the restorable database accounts and their properties." + }, + "RestorableDatabaseAccountGetResult": { + "description": "A Azure Cosmos DB restorable database account.", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a restorable database account.", + "$ref": "#/definitions/RestorableDatabaseAccountProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + } + } + }, + "RestorableDatabaseAccountProperties": { + "type": "object", + "description": "The properties of a restorable database account.", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the global database account" + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The creation time of the restorable database account (ISO-8601 format)." + }, + "deletionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the restorable database account has been deleted (ISO-8601 format)." + }, + "oldestRestorableTime": { + "type": "string", + "format": "date-time", + "description": "The least recent time at which the database account can be restored to (ISO-8601 format)." + }, + "apiType": { + "type": "string", + "readOnly": true, + "description": "The API type of the restorable database account.", + "$ref": "#/definitions/ApiType" + }, + "restorableLocations": { + "type": "array", + "readOnly": true, + "description": "List of regions where the of the database account can be restored from.", + "items": { + "$ref": "#/definitions/RestorableLocationResource" + } + } + } + }, + "ApiType": { + "description": "Enum to indicate the API type of the restorable database account.", + "type": "string", + "readOnly": true, + "enum": [ + "MongoDB", + "Gremlin", + "Cassandra", + "Table", + "Sql", + "GremlinV2" + ], + "x-ms-enum": { + "name": "ApiType", + "modelAsString": true + } + }, + "RestorableLocationResource": { + "type": "object", + "description": "Properties of the regional restorable account.", + "properties": { + "locationName": { + "type": "string", + "readOnly": true, + "description": "The location of the regional restorable account." + }, + "regionalDatabaseAccountInstanceId": { + "type": "string", + "readOnly": true, + "description": "The instance id of the regional restorable account." + }, + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The creation time of the regional restorable database account (ISO-8601 format)." + }, + "deletionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The time at which the regional restorable database account has been deleted (ISO-8601 format)." + } + } + }, + "RestorableSqlDatabasesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableSqlDatabaseGetResult" + }, + "description": "List of SQL database events and their properties." + } + }, + "description": "The List operation response, that contains the SQL database events and their properties." + }, + "RestorableSqlDatabaseGetResult": { + "description": "An Azure Cosmos DB SQL database event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a SQL database event.", + "$ref": "#/definitions/RestorableSqlDatabaseProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableSqlDatabaseProperties": { + "description": "The properties of an Azure Cosmos DB SQL database event", + "type": "object", + "properties": { + "resource": { + "type": "object", + "description": "The resource of an Azure Cosmos DB SQL database event", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this database event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this database to identify if this database is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this database can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this database event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of the SQL database." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of the SQL database." + }, + "database": { + "type": "object", + "description": "Cosmos DB SQL database resource object", + "properties": { + "_colls": { + "type": "string", + "readOnly": true, + "description": "A system generated property that specified the addressable path of the collections resource." + }, + "_users": { + "type": "string", + "readOnly": true, + "description": "A system generated property that specifies the addressable path of the users resource." + }, + "_self": { + "type": "string", + "readOnly": true, + "description": "A system generated property that specifies the addressable path of the database resource." + } + }, + "allOf": [ + { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/SqlDatabaseResource" + }, + { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ExtendedResourceProperties" + } + ] + } + } + } + } + }, + "RestorableSqlContainersListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableSqlContainerGetResult" + }, + "description": "List of SQL container events and their properties." + } + }, + "description": "The List operation response, that contains the SQL container events and their properties." + }, + "RestorableSqlContainerGetResult": { + "description": "An Azure Cosmos DB SQL container event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a SQL container event.", + "$ref": "#/definitions/RestorableSqlContainerProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableSqlContainerProperties": { + "description": "The properties of an Azure Cosmos DB SQL container event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB SQL container event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this container event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this container to identify if this container is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this container can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The when this container event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this SQL container." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this SQL container." + }, + "container": { + "type": "object", + "description": "Cosmos DB SQL container resource object", + "properties": { + "_self": { + "type": "string", + "readOnly": true, + "description": "A system generated property that specifies the addressable path of the container resource." + } + }, + "allOf": [ + { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/SqlContainerResource" + }, + { + "$ref": "../../stable/2023-11-15/cosmos-db.json#/definitions/ExtendedResourceProperties" + } + ] + } + } + } + } + }, + "RestorableSqlResourcesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableSqlResourcesGetResult" + }, + "description": "List of restorable SQL resources, including the database and collection names." + } + }, + "description": "The List operation response, that contains the restorable SQL resources." + }, + "RestorableSqlResourcesGetResult": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "databaseName": { + "type": "string", + "description": "The name of the database available for restore." + }, + "collectionNames": { + "type": "array", + "description": "The names of the collections available for restore.", + "items": { + "$ref": "cosmos-db.json#/definitions/CollectionName" + } + } + } + }, + "RestorableMongodbDatabasesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableMongodbDatabaseGetResult" + }, + "description": "List of MongoDB database events and their properties." + } + }, + "description": "The List operation response, that contains the MongoDB database events and their properties." + }, + "RestorableMongodbDatabaseGetResult": { + "description": "An Azure Cosmos DB MongoDB database event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a MongoDB database event.", + "$ref": "#/definitions/RestorableMongodbDatabaseProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableMongodbDatabaseProperties": { + "description": "The properties of an Azure Cosmos DB MongoDB database event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB MongoDB database event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this database event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this database to identify if this database is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this database can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this database event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this MongoDB database." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this MongoDB database." + } + } + } + } + }, + "RestorableMongodbCollectionsListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableMongodbCollectionGetResult" + }, + "description": "List of MongoDB collection events and their properties." + } + }, + "description": "The List operation response, that contains the MongoDB collection events and their properties." + }, + "RestorableMongodbCollectionGetResult": { + "description": "An Azure Cosmos DB MongoDB collection event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a MongoDB collection event.", + "$ref": "#/definitions/RestorableMongodbCollectionProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableMongodbCollectionProperties": { + "description": "The properties of an Azure Cosmos DB MongoDB collection event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB MongoDB collection event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this collection event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this collection to identify if this container is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this collection can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this collection event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this MongoDB collection." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this MongoDB collection." + } + } + } + } + }, + "RestorableMongodbResourcesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableMongodbResourcesGetResult" + }, + "description": "List of restorable MongoDB resources, including the database and collection names." + } + }, + "description": "The List operation response, that contains the restorable MongoDB resources." + }, + "RestorableMongodbResourcesGetResult": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "databaseName": { + "type": "string", + "description": "The name of the database available for restore." + }, + "collectionNames": { + "type": "array", + "description": "The names of the collections available for restore.", + "items": { + "$ref": "cosmos-db.json#/definitions/CollectionName" + } + } + } + }, + "RestorableGremlinDatabasesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableGremlinDatabaseGetResult" + }, + "description": "List of Gremlin database events and their properties." + } + }, + "description": "The List operation response, that contains the Gremlin database events and their properties." + }, + "RestorableGremlinDatabaseGetResult": { + "description": "An Azure Cosmos DB Gremlin database event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a Gremlin database event.", + "$ref": "#/definitions/RestorableGremlinDatabaseProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableGremlinDatabaseProperties": { + "description": "The properties of an Azure Cosmos DB Gremlin database event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB Gremlin database event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this database event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this database to identify if this database is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this database can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this database event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this Gremlin database." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this Gremlin database." + } + } + } + } + }, + "RestorableGremlinGraphsListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableGremlinGraphGetResult" + }, + "description": "List of Gremlin graph events and their properties." + } + }, + "description": "The List operation response, that contains the Gremlin graph events and their properties." + }, + "RestorableGremlinGraphGetResult": { + "description": "An Azure Cosmos DB Gremlin graph event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a Gremlin graph event.", + "$ref": "#/definitions/RestorableGremlinGraphProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableGremlinGraphProperties": { + "description": "The properties of an Azure Cosmos DB Gremlin graph event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB Gremlin graph event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this graph event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this graph to identify if this graph is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this graph can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this graph event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this Gremlin graph." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this Gremlin graph." + } + } + } + } + }, + "RestorableGremlinResourcesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableGremlinResourcesGetResult" + }, + "description": "List of restorable Gremlin resources, including the gremlin database and graph names.", + "x-ms-identifiers": [] + } + }, + "description": "The List operation response, that contains the restorable Gremlin resources." + }, + "RestorableGremlinResourcesGetResult": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "databaseName": { + "type": "string", + "description": "The name of the gremlin database available for restore." + }, + "graphNames": { + "type": "array", + "description": "The names of the graphs available for restore.", + "items": { + "$ref": "cosmos-db.json#/definitions/GraphName" + } + } + } + }, + "RestorableTablesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableTableGetResult" + }, + "description": "List of Table events and their properties." + } + }, + "description": "The List operation response, that contains the Table events and their properties." + }, + "RestorableTableGetResult": { + "description": "An Azure Cosmos DB Table event", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a Table event.", + "$ref": "#/definitions/RestorableTableProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource Identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "RestorableTableProperties": { + "description": "The properties of an Azure Cosmos DB Table event", + "type": "object", + "properties": { + "resource": { + "description": "The resource of an Azure Cosmos DB Table event", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "readOnly": true, + "description": "A system generated property. A unique identifier." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "The operation type of this table event.", + "$ref": "#/definitions/OperationType" + }, + "canUndelete": { + "type": "string", + "readOnly": true, + "description": "A state of this table to identify if this table is restorable in same account." + }, + "canUndeleteReason": { + "type": "string", + "readOnly": true, + "description": "The reason why this table can not be restored in same account." + }, + "eventTimestamp": { + "type": "string", + "readOnly": true, + "description": "The time when this table event happened." + }, + "ownerId": { + "type": "string", + "readOnly": true, + "description": "The name of this Table." + }, + "ownerResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource ID of this Table." + } + } + } + } + }, + "RestorableTableResourcesListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableTableResourcesGetResult" + }, + "description": "List of restorable table names." + } + }, + "description": "List of restorable table names." + }, + "RestorableTableResourcesGetResult": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the Table." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + } + }, + "OperationType": { + "description": "Enum to indicate the operation type of the event.", + "type": "string", + "readOnly": true, + "enum": [ + "Create", + "Replace", + "Delete", + "Recreate", + "SystemOperation" + ], + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true + } + }, + "ContinuousBackupRestoreLocation": { + "type": "object", + "description": "Properties of the regional restorable account.", + "properties": { + "location": { + "type": "string", + "description": "The name of the continuous backup restore location." + } + } + }, + "BackupInformation": { + "description": "Backup information of a resource.", + "type": "object", + "properties": { + "continuousBackupInformation": { + "description": "Information about the status of continuous backups.", + "type": "object", + "$ref": "#/definitions/ContinuousBackupInformation" + } + } + }, + "ContinuousBackupInformation": { + "description": "Information about the status of continuous backups.", + "type": "object", + "readOnly": true, + "properties": { + "latestRestorableTimestamp": { + "type": "string", + "description": "The latest restorable timestamp for a resource." + } + } + } + }, + "parameters": { + "restorableSqlDatabaseRidParameter": { + "name": "restorableSqlDatabaseRid", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource ID of the SQL database." + }, + "restorableMongodbDatabaseRidParameter": { + "name": "restorableMongodbDatabaseRid", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource ID of the MongoDB database." + }, + "restoreLocationParameter": { + "name": "restoreLocation", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The location where the restorable resources are located." + }, + "restoreTimestampInUtcParameter": { + "name": "restoreTimestampInUtc", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The timestamp when the restorable resources existed." + }, + "restorableSqlContainersEventFeedStartTime": { + "name": "startTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Sql containers event feed start time." + }, + "restorableSqlContainersEventFeedEndTime": { + "name": "endTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Sql containers event feed end time." + }, + "restorableMongoDBCollectionsEventFeedStartTime": { + "name": "startTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable MongoDB collections event feed start time." + }, + "restorableMongoDBCollectionsEventFeedEndTime": { + "name": "endTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable MongoDB collections event feed end time." + }, + "restorableGremlinGraphsEventFeedStartTime": { + "name": "startTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Gremlin graphs event feed start time." + }, + "restorableGremlinGraphsEventFeedEndTime": { + "name": "endTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Gremlin graphs event feed end time." + }, + "restorableTablesEventFeedStartTime": { + "name": "startTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Tables event feed start time." + }, + "restorableTablesEventFeedEndTime": { + "name": "endTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Restorable Tables event feed end time." + }, + "restoreStartTime": { + "name": "startTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The snapshot create timestamp after which snapshots need to be listed." + }, + "restoreEndTime": { + "name": "endTime", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The snapshot create timestamp before which snapshots need to be listed." + }, + "locationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + }, + "instanceIdParameter": { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The instanceId GUID of a restorable database account." + }, + "restorableGremlinDatabaseRidParameter": { + "name": "restorableGremlinDatabaseRid", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource ID of the Gremlin database." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/services.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/services.json new file mode 100644 index 000000000000..cf588d5dffed --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/services.json @@ -0,0 +1,642 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2023-11-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services": { + "get": { + "x-ms-examples": { + "CosmosDBServicesList": { + "$ref": "./examples/CosmosDBServicesList.json" + } + }, + "operationId": "Service_List", + "description": "Gets the status of service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The ServiceResource.", + "schema": { + "$ref": "#/definitions/ServiceResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": ".../../cosmos-db.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/services/{serviceName}": { + "put": { + "tags": [ + "DataTransfer", + "SqlDedicatedGateway", + "GraphAPICompute", + "MaterializedViewsBuilder" + ], + "x-ms-examples": { + "DataTransferServiceCreate": { + "$ref": "./examples/CosmosDBDataTransferServiceCreate.json" + }, + "SqlDedicatedGatewayServiceCreate": { + "$ref": "./examples/CosmosDBSqlDedicatedGatewayServiceCreate.json" + }, + "GraphAPIComputeServiceCreate": { + "$ref": "./examples/CosmosDBGraphAPIComputeServiceCreate.json" + }, + "MaterializedViewsBuilderServiceCreate": { + "$ref": "./examples/CosmosDBMaterializedViewsBuilderServiceCreate.json" + } + }, + "operationId": "Service_Create", + "description": "Creates a service.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/serviceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResourceCreateUpdateParameters" + }, + "description": "The Service resource parameters." + } + ], + "responses": { + "200": { + "description": "The service status.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "202": { + "description": "The job will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": ".../../cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "DataTransfer", + "SqlDedicatedGateway", + "GraphAPICompute", + "MaterializedViewsBuilder" + ], + "x-ms-examples": { + "DataTransferServiceGet": { + "$ref": "./examples/CosmosDBDataTransferServiceGet.json" + }, + "GraphAPIComputeServiceGet": { + "$ref": "./examples/CosmosDBGraphAPIComputeServiceGet.json" + }, + "SqlDedicatedGatewayServiceGet": { + "$ref": "./examples/CosmosDBSqlDedicatedGatewayServiceGet.json" + }, + "MaterializedViewsBuilderServiceGet": { + "$ref": "./examples/CosmosDBMaterializedViewsBuilderServiceGet.json" + } + }, + "operationId": "Service_Get", + "description": "Gets the status of service.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/serviceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The ServiceResource.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": ".../../cosmos-db.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "DataTransfer", + "SqlDedicatedGateway", + "GraphAPICompute", + "MaterializedViewsBuilder" + ], + "x-ms-examples": { + "DataTransferServiceDelete": { + "$ref": "./examples/CosmosDBDataTransferServiceDelete.json" + }, + "SqlDedicatedGatewayServiceDelete": { + "$ref": "./examples/CosmosDBSqlDedicatedGatewayServiceDelete.json" + }, + "GraphAPIComputeServiceDelete": { + "$ref": "./examples/CosmosDBGraphAPIComputeServiceDelete.json" + }, + "MaterializedViewsBuilderServiceDelete": { + "$ref": "./examples/CosmosDBMaterializedViewsBuilderServiceDelete.json" + } + }, + "operationId": "Service_Delete", + "description": "Deletes service with the given serviceName.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/serviceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The job will complete asynchronously.", + "headers": { + "azure-AsyncOperation": { + "type": "string", + "description": "URI to poll for completion status." + }, + "location": { + "type": "string", + "description": "URI to poll for completion status." + } + } + }, + "204": { + "description": "The response for service deletion." + }, + "200": { + "description": "The response for service deletion." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": ".../../cosmos-db.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ServiceResourceProperties": { + "description": "Services response resource.", + "type": "object", + "discriminator": "serviceType", + "properties": { + "creationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Time of the last state change (ISO-8601 format)." + }, + "instanceSize": { + "$ref": "#/definitions/ServiceResourceInstanceSize" + }, + "instanceCount": { + "description": "Instance count for the service.", + "type": "integer", + "minimum": 0, + "format": "int32" + }, + "serviceType": { + "$ref": "#/definitions/ServiceType" + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ServiceResourceStatus" + } + }, + "additionalProperties": true, + "required": [ + "serviceType" + ] + }, + "ServiceResourceCreateUpdateParameters": { + "description": "Parameters for Create or Update Request for ServiceResource", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceCreateUpdateProperties" + } + } + }, + "ServiceResourceCreateUpdateProperties": { + "description": "Properties in ServiceResourceCreateUpdateParameters.", + "type": "object", + "properties": { + "instanceSize": { + "$ref": "#/definitions/ServiceResourceInstanceSize" + }, + "instanceCount": { + "description": "Instance count for the service.", + "type": "integer", + "minimum": 0, + "format": "int32" + }, + "serviceType": { + "$ref": "#/definitions/ServiceType" + } + } + }, + "ServiceResource": { + "description": "Properties for the database account.", + "type": "object", + "allOf": [ + { + "$ref": ".../../cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/ServiceResourceProperties" + } + } + }, + "ServiceResourceListResult": { + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResource" + }, + "description": "List of Service Resource and their properties." + } + }, + "description": "The List operation response, that contains the Service Resource and their properties." + }, + "DataTransferServiceResource": { + "description": "Describes the service response property.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/DataTransferServiceResourceProperties" + } + } + }, + "DataTransferServiceResourceProperties": { + "description": "Properties for DataTransferServiceResource.", + "type": "object", + "x-ms-discriminator-value": "DataTransfer", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "properties": { + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations for the service.", + "items": { + "$ref": "#/definitions/DataTransferRegionalServiceResource" + } + } + } + }, + "SqlDedicatedGatewayServiceResource": { + "description": "Describes the service response property for SqlDedicatedGateway.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/SqlDedicatedGatewayServiceResourceProperties" + } + } + }, + "SqlDedicatedGatewayServiceResourceProperties": { + "description": "Properties for SqlDedicatedGatewayServiceResource.", + "type": "object", + "x-ms-discriminator-value": "SqlDedicatedGateway", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "properties": { + "sqlDedicatedGatewayEndpoint": { + "type": "string", + "description": "SqlDedicatedGateway endpoint for the service." + }, + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations for the service.", + "items": { + "$ref": "#/definitions/SqlDedicatedGatewayRegionalServiceResource" + } + } + } + }, + "GraphAPIComputeServiceResource": { + "description": "Describes the service response property for GraphAPICompute.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/GraphAPIComputeServiceResourceProperties" + } + } + }, + "GraphAPIComputeServiceResourceProperties": { + "description": "Properties for GraphAPIComputeServiceResource.", + "type": "object", + "x-ms-discriminator-value": "GraphAPICompute", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "properties": { + "graphApiComputeEndpoint": { + "type": "string", + "description": "GraphAPICompute endpoint for the service." + }, + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations for the service.", + "items": { + "$ref": "#/definitions/GraphAPIComputeRegionalServiceResource" + } + } + } + }, + "MaterializedViewsBuilderServiceResource": { + "description": "Describes the service response property for MaterializedViewsBuilder.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/MaterializedViewsBuilderServiceResourceProperties" + } + } + }, + "MaterializedViewsBuilderServiceResourceProperties": { + "description": "Properties for MaterializedViewsBuilderServiceResource.", + "type": "object", + "x-ms-discriminator-value": "MaterializedViewsBuilder", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "properties": { + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations for the service.", + "items": { + "$ref": "#/definitions/MaterializedViewsBuilderRegionalServiceResource" + } + } + } + }, + "RegionalServiceResource": { + "description": "Resource for a regional service location.", + "type": "object", + "readOnly": true, + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The regional service name." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location name." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ServiceResourceStatus" + } + } + }, + "SqlDedicatedGatewayRegionalServiceResource": { + "description": "Resource for a regional service location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RegionalServiceResource" + } + ], + "properties": { + "sqlDedicatedGatewayEndpoint": { + "readOnly": true, + "type": "string", + "description": "The regional endpoint for SqlDedicatedGateway." + } + } + }, + "GraphAPIComputeRegionalServiceResource": { + "description": "Resource for a regional service location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RegionalServiceResource" + } + ], + "properties": { + "graphApiComputeEndpoint": { + "readOnly": true, + "type": "string", + "description": "The regional endpoint for GraphAPICompute." + } + } + }, + "DataTransferRegionalServiceResource": { + "description": "Resource for a regional service location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RegionalServiceResource" + } + ] + }, + "MaterializedViewsBuilderRegionalServiceResource": { + "description": "Resource for a regional service location.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RegionalServiceResource" + } + ] + }, + "ServiceResourceStatus": { + "type": "string", + "enum": [ + "Creating", + "Running", + "Updating", + "Deleting", + "Error", + "Stopped" + ], + "readOnly": true, + "description": "Describes the status of a service.", + "x-ms-enum": { + "modelAsString": true, + "name": "ServiceStatus" + } + }, + "ServiceResourceInstanceSize": { + "type": "string", + "enum": [ + "Cosmos.D4s", + "Cosmos.D8s", + "Cosmos.D16s" + ], + "description": "Instance type for the service.", + "x-ms-enum": { + "modelAsString": true, + "name": "ServiceSize" + } + }, + "ServiceType": { + "type": "string", + "enum": [ + "SqlDedicatedGateway", + "DataTransfer", + "GraphAPICompute", + "MaterializedViewsBuilder" + ], + "description": "ServiceType for the service.", + "x-ms-enum": { + "modelAsString": true, + "name": "ServiceType" + } + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "serviceNameParameter": { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB service name.", + "minLength": 3, + "maxLength": 50 + } + } +} diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index f356d9aff9a9..7420a4109c22 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -27,15 +27,31 @@ These are the global settings for the Cosmos-DB API. ``` yaml title: CosmosDBManagementClient openapi-type: arm -tag: package-2023-09 +tag: package-2023-11 ``` +### Tag: package-2023-11 + +These settings apply only when `--tag=package-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-2023-11' +input-file: + - Microsoft.DocumentDB/stable/2023-11-15/cosmos-db.json + - Microsoft.DocumentDB/stable/2023-11-15/managedCassandra.json + - Microsoft.DocumentDB/stable/2023-11-15/mongorbac.json + - Microsoft.DocumentDB/stable/2023-11-15/notebook.json + - Microsoft.DocumentDB/stable/2023-11-15/privateEndpointConnection.json + - Microsoft.DocumentDB/stable/2023-11-15/privateLinkResources.json + - Microsoft.DocumentDB/stable/2023-11-15/rbac.json + - Microsoft.DocumentDB/stable/2023-11-15/restorable.json + - Microsoft.DocumentDB/stable/2023-11-15/services.json +``` ### Tag: package-2023-09 These settings apply only when `--tag=package-2023-09` is specified on the command line. -```yaml $(tag) == 'package-2023-09' +``` yaml $(tag) == 'package-2023-09' input-file: - Microsoft.DocumentDB/stable/2023-09-15/cosmos-db.json - Microsoft.DocumentDB/stable/2023-09-15/managedCassandra.json @@ -52,7 +68,7 @@ input-file: These settings apply only when `--tag=package-preview-2023-09` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-09' +``` yaml $(tag) == 'package-preview-2023-09' input-file: - Microsoft.DocumentDB/preview/2023-09-15-preview/cosmos-db.json - Microsoft.DocumentDB/preview/2023-09-15-preview/dataTransferService.json @@ -66,6 +82,7 @@ input-file: - Microsoft.DocumentDB/preview/2023-09-15-preview/restorable.json - Microsoft.DocumentDB/preview/2023-09-15-preview/services.json ``` + ### Tag: package-preview-2023-03-15 These settings apply only when `--tag=package-preview-2023-03-15` is specified on the command line. diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/common-types.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/common-types.json new file mode 100644 index 000000000000..9d58cab6a728 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/common-types.json @@ -0,0 +1,231 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01", + "title": "CostManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.CostManagement/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available cost management REST API operations.", + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorDetailsWithNestedDetails": { + "description": "The details of the error.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ErrorDetails" + } + ], + "properties": { + "details": { + "type": "array", + "readOnly": true, + "description": "The additional details of the error.", + "items": { + "$ref": "#/definitions/ErrorDetailsWithNestedDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "ErrorResponseWithNestedDetails": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetailsWithNestedDetails" + } + } + }, + "CostManagementOperation": { + "description": "A Cost management REST API operation.", + "type": "object", + "properties": { + "id": { + "description": "Operation id: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Operation" + } + ] + }, + "OperationListResult": { + "description": "Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of cost management operations supported by the Microsoft.CostManagement resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CostManagementOperation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "CostManagementProxyResource": { + "description": "The Resource model definition.", + "type": "object", + "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." + }, + "eTag": { + "type": "string", + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." + } + }, + "x-ms-azure-resource": true + }, + "DownloadURL": { + "description": "The URL to download the generated report.", + "type": "object", + "properties": { + "expiryTime": { + "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "validTill": { + "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", + "type": "string", + "format": "date-time" + }, + "downloadUrl": { + "description": "The URL to download the generated report.", + "type": "string" + } + } + } + }, + "parameters": { + "billingAccountIdParameter": { + "description": "Billing account ID", + "in": "path", + "name": "billingAccountId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingProfileIdParameter": { + "description": "Billing profile ID.", + "in": "path", + "name": "billingProfileId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costallocation.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costallocation.json new file mode 100644 index 000000000000..b2b0d060c4b3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costallocation.json @@ -0,0 +1,617 @@ +{ + "swagger": "2.0", + "info": { + "title": "CostManagementClient", + "version": "2023-11-01" + }, + "tags": [ + { + "name": "CostAllocationRules", + "description": "An API for creating and managing cost allocation rules within a billing account or enterprise enrollment. These rules can be used to reallocate cost between resources, filtered by Resource Group, Subscription, or Tag." + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules": { + "get": { + "tags": [ + "CostAllocationRules" + ], + "operationId": "CostAllocationRules_List", + "description": "Get the list of all cost allocation rules for a billing account or enterprise enrollment.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CostAllocationRulesList": { + "$ref": "./examples/CostAllocationRulesList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + } + ], + "responses": { + "200": { + "description": "List of cost allocation rules for the billing account or enterprise enrollment.", + "schema": { + "$ref": "#/definitions/CostAllocationRuleList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/checkNameAvailability": { + "post": { + "tags": [ + "CostAllocationRules" + ], + "operationId": "CostAllocationRules_CheckNameAvailability", + "description": "Checks availability and correctness of a name for a cost allocation rule", + "x-ms-examples": { + "CostAllocationRuleCheckNameAvailability": { + "$ref": "./examples/CostAllocationRuleCheckNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "name": "costAllocationRuleCheckNameAvailabilityRequest", + "description": "Cost allocation rule to be created or updated", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CostAllocationRuleCheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Response of cost allocation rule name availability.", + "schema": { + "$ref": "#/definitions/CostAllocationRuleCheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}": { + "get": { + "tags": [ + "CostAllocationRules" + ], + "operationId": "CostAllocationRules_Get", + "description": "Get a cost allocation rule by rule name and billing account or enterprise enrollment.", + "x-ms-examples": { + "CostAllocationRules": { + "$ref": "./examples/CostAllocationRuleGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/ruleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CostAllocationRuleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CostAllocationRules" + ], + "operationId": "CostAllocationRules_CreateOrUpdate", + "description": "Create/Update a rule to allocate cost between different resources within a billing account or enterprise enrollment.", + "x-ms-examples": { + "CostAllocationRulesCreateResourceGroup": { + "$ref": "./examples/CostAllocationRuleCreate.json" + }, + "CostAllocationRulesCreateTag": { + "$ref": "./examples/CostAllocationRuleCreateTag.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/ruleNameParameter" + }, + { + "name": "costAllocationRule", + "description": "Cost allocation rule to be created or updated", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CostAllocationRuleDefinition" + } + } + ], + "responses": { + "200": { + "description": "OK. The update request has succeeded.", + "schema": { + "$ref": "#/definitions/CostAllocationRuleDefinition" + } + }, + "201": { + "description": "Created. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CostAllocationRuleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "CostAllocationRules" + ], + "operationId": "CostAllocationRules_Delete", + "description": "Delete cost allocation rule for billing account or enterprise enrollment.", + "x-ms-examples": { + "DeleteCostAllocationRule": { + "$ref": "./examples/CostAllocationRuleDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/ruleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Rule did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ErrorDetails": { + "description": "The details of the error.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "CostAllocationRuleList": { + "type": "object", + "description": "Result of listing cost allocation rules. It contains a list of available rules in the billing account or enterprise enrollment provided.", + "properties": { + "value": { + "description": "The list of cost allocation rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CostAllocationRuleDefinition" + }, + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "URL to get the next set of rule list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "CostAllocationRuleCheckNameAvailabilityRequest": { + "type": "object", + "description": "The cost allocation rule check name availability request", + "properties": { + "name": { + "type": "string", + "description": "Rule name" + }, + "type": { + "type": "string", + "description": "Resource type. This is expected to be Microsoft.CostManagement/costAllocationRules" + } + } + }, + "CostAllocationRuleCheckNameAvailabilityResponse": { + "type": "object", + "description": "The cost allocation rule check name availability response", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Whether this rule name is available" + }, + "reason": { + "$ref": "#/definitions/Reason", + "description": "The reason this name is not available" + }, + "message": { + "type": "string", + "description": "Error message if the name is not available" + } + } + }, + "Reason": { + "type": "string", + "description": "The reason this name is not available.", + "enum": [ + "Invalid", + "AlreadyExists", + "Valid" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": true + } + }, + "CostAllocationRuleDefinition": { + "type": "object", + "description": "The cost allocation rule model definition", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure Resource Manager Id for the rule. This is a read ony value." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the rule. This is a read only value." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type of the rule. This is a read only value of Microsoft.CostManagement/CostAllocationRule." + }, + "properties": { + "description": "Cost allocation rule properties", + "$ref": "#/definitions/CostAllocationRuleProperties" + } + }, + "x-ms-azure-resource": true + }, + "CostAllocationRuleProperties": { + "type": "object", + "description": "The properties of a cost allocation rule", + "additionalProperties": false, + "required": [ + "details", + "status" + ], + "properties": { + "description": { + "description": "Description of a cost allocation rule.", + "type": "string" + }, + "details": { + "description": "Resource information for the cost allocation rule", + "$ref": "#/definitions/CostAllocationRuleDetails" + }, + "status": { + "$ref": "#/definitions/RuleStatus", + "description": "Status of the rule" + }, + "createdDate": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation." + }, + "updatedDate": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time at which the rule was last updated." + } + } + }, + "RuleStatus": { + "type": "string", + "description": "Current status of the rule.", + "enum": [ + "NotActive", + "Active", + "Processing" + ], + "x-ms-enum": { + "name": "RuleStatus", + "modelAsString": true, + "values": [ + { + "value": "NotActive", + "description": "Rule is saved but not used to allocate costs.", + "name": "NotActive" + }, + { + "value": "Active", + "description": "Rule is saved and impacting cost allocation.", + "name": "Active" + }, + { + "value": "Processing", + "description": "Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request.", + "name": "Processing" + } + ] + } + }, + "CostAllocationRuleDetails": { + "type": "object", + "description": "Resource details of the cost allocation rule", + "properties": { + "sourceResources": { + "description": "Source resources for cost allocation. At this time, this list can contain no more than one element.", + "type": "array", + "items": { + "$ref": "#/definitions/SourceCostAllocationResource" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "targetResources": { + "type": "array", + "description": "Target resources for cost allocation. At this time, this list can contain no more than one element.", + "items": { + "$ref": "#/definitions/TargetCostAllocationResource" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "CostAllocationResource": { + "type": "object", + "description": "Common values for resources for cost allocation", + "required": [ + "resourceType", + "name" + ], + "properties": { + "resourceType": { + "description": "Type of resources contained in this cost allocation rule", + "$ref": "#/definitions/CostAllocationResourceType" + }, + "name": { + "description": "If resource type is dimension, this must be either ResourceGroupName or SubscriptionId. If resource type is tag, this must be a valid Azure tag", + "type": "string" + } + } + }, + "SourceCostAllocationResource": { + "allOf": [ + { + "$ref": "#/definitions/CostAllocationResource" + }, + { + "type": "object", + "properties": { + "values": { + "description": "Source Resources for cost allocation. This list cannot contain more than 25 values.", + "type": "array", + "items": { + "description": "Source resource for cost allocation", + "type": "string" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "values" + ] + } + ], + "description": "Source resources for cost allocation" + }, + "TargetCostAllocationResource": { + "description": "Target resources for cost allocation.", + "allOf": [ + { + "$ref": "#/definitions/CostAllocationResource" + }, + { + "type": "object", + "properties": { + "values": { + "description": "Target resources for cost allocation. This list cannot contain more than 25 values.", + "type": "array", + "items": { + "$ref": "#/definitions/CostAllocationProportion" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "policyType": { + "description": "Method of cost allocation for the rule", + "$ref": "#/definitions/CostAllocationPolicyType" + } + }, + "required": [ + "values", + "policyType" + ] + } + ] + }, + "CostAllocationResourceType": { + "type": "string", + "description": "Category of resource to use for allocation.", + "enum": [ + "Dimension", + "Tag" + ], + "x-ms-enum": { + "name": "CostAllocationResourceType", + "modelAsString": true, + "values": [ + { + "value": "Dimension", + "description": "Indicates an Azure dimension such as a subscription id or resource group name is being used for allocation.", + "name": "Dimension" + }, + { + "value": "Tag", + "description": "Allocates cost based on Azure Tag key value pairs.", + "name": "Tag" + } + ] + } + }, + "CostAllocationProportion": { + "type": "object", + "description": "Target resources and allocation", + "required": [ + "percentage", + "name" + ], + "properties": { + "name": { + "description": "Target resource for cost allocation", + "type": "string" + }, + "percentage": { + "description": "Percentage of source cost to allocate to this resource. This value can be specified to two decimal places and the total percentage of all resources in this rule must sum to 100.00.", + "type": "number" + } + } + }, + "CostAllocationPolicyType": { + "type": "string", + "description": "Method to use for allocating cost. FixedProportion indicates that cost will be split based on specified percentage values.", + "enum": [ + "FixedProportion" + ], + "x-ms-enum": { + "name": "CostAllocationPolicyType", + "modelAsString": true + } + } + }, + "parameters": { + "billingAccountIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "BillingAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ruleNameParameter": { + "name": "ruleName", + "in": "path", + "description": "Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "[A-Za-z0-9\\-_]+" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.benefits.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.benefits.json new file mode 100644 index 000000000000..1a52ebc9942c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.benefits.json @@ -0,0 +1,1481 @@ +{ + "swagger": "2.0", + "info": { + "title": "CostManagementClient", + "description": "CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions.", + "version": "2023-11-01" + }, + "tags": [ + { + "name": "Benefits API", + "description": "APIs for getting benefit recommendations and benefit utilization summaries." + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations": { + "get": { + "tags": [ + "BenefitRecommendations" + ], + "description": "List of recommendations for purchasing savings plan.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" + }, + "x-ms-examples": { + "BenefitRecommendationsBillingAccountList": { + "$ref": "./examples/BenefitRecommendationsByBillingAccount.json" + } + }, + "operationId": "BenefitRecommendations_List", + "parameters": [ + { + "$ref": "#/parameters/benefitRecommendationsFilterParameter" + }, + { + "name": "$orderby", + "in": "query", + "description": "May be used to order the recommendations by: properties/armSkuName. For the savings plan, the results are in order by default. There is no need to use this clause.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "$expand", + "in": "query", + "description": "May be used to expand the properties by: properties/usage, properties/allRecommendationDetails", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingScopeBenefitRecommendationParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/benefitRecommendationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { + "get": { + "tags": [ + "BenefitUtilizationSummaries" + ], + "operationId": "BenefitUtilizationSummaries_ListByBillingAccountId", + "description": "Lists savings plan utilization summaries for the enterprise agreement scope. Supported at grain values: 'Daily' and 'Monthly'.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common-types.json#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "name": "filter", + "in": "query", + "description": "Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SavingsPlanUtilizationSummaries-BillingAccount": { + "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { + "get": { + "tags": [ + "BenefitUtilizationSummaries" + ], + "operationId": "BenefitUtilizationSummaries_ListByBillingProfileId", + "description": "Lists savings plan utilization summaries for billing profile. Supported at grain values: 'Daily' and 'Monthly'.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common-types.json#/parameters/billingAccountIdParameter" + }, + { + "$ref": "common-types.json#/parameters/billingProfileIdParameter" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "name": "filter", + "in": "query", + "description": "Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SavingsPlanUtilizationSummaries-BillingProfile": { + "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { + "get": { + "tags": [ + "BenefitUtilizationSummaries" + ], + "operationId": "BenefitUtilizationSummaries_ListBySavingsPlanOrder", + "description": "Lists the savings plan utilization summaries for daily or monthly grain.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" + }, + "x-ms-examples": { + "SavingsPlanUtilizationSummariesDaily": { + "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "Supports filtering by properties/usageDate.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "$ref": "#/parameters/savingsPlanOrderIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { + "get": { + "tags": [ + "BenefitUtilizationSummaries" + ], + "operationId": "BenefitUtilizationSummaries_ListBySavingsPlanId", + "description": "Lists the savings plan utilization summaries for daily or monthly grain.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" + }, + "x-ms-examples": { + "SavingsPlanUtilizationSummariesMonthlyWithSavingsPlanId": { + "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "Supports filtering by properties/usageDate.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "$ref": "#/parameters/savingsPlanOrderIdParameter" + }, + { + "$ref": "#/parameters/savingsPlanIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { + "post": { + "tags": [ + "BenefitUtilizationSummariesAsync" + ], + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByBillingAccount", + "description": "Triggers generation of a benefit utilization summaries report for the provided billing account. This API supports only enrollment accounts.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "GenerateUtilizationSummariesReportByBillingAccount": { + "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "common-types.json#/parameters/billingAccountIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "benefitUtilizationSummariesRequest", + "description": "Async Benefit Utilization Summary report to be created.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesRequest" + } + } + ], + "responses": { + "200": { + "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { + "post": { + "tags": [ + "BenefitUtilizationSummariesAsync" + ], + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByBillingProfile", + "description": "Triggers generation of a benefit utilization summaries report for the provided billing account and billing profile.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "GenerateUtilizationSummariesReportByBillingProfile": { + "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "common-types.json#/parameters/billingAccountIdParameter" + }, + { + "$ref": "common-types.json#/parameters/billingProfileIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "benefitUtilizationSummariesRequest", + "description": "Async Benefit Utilization Summary report to be created.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesRequest" + } + } + ], + "responses": { + "200": { + "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { + "post": { + "tags": [ + "BenefitUtilizationSummariesAsync" + ], + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByReservationOrderId", + "description": "Triggers generation of a benefit utilization summaries report for the provided reservation order.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "GenerateUtilizationSummariesReportByReservationOrder": { + "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/reservationOrderIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "benefitUtilizationSummariesRequest", + "description": "Async Benefit Utilization Summary report to be created.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesRequest" + } + } + ], + "responses": { + "200": { + "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { + "post": { + "tags": [ + "BenefitUtilizationSummariesAsync" + ], + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateByReservationId", + "description": "Triggers generation of a benefit utilization summaries report for the provided reservation.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "GenerateUtilizationSummariesReportByReservation": { + "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/reservationOrderIdParameter" + }, + { + "$ref": "#/parameters/reservationIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "benefitUtilizationSummariesRequest", + "description": "Async Benefit Utilization Summary report to be created.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesRequest" + } + } + ], + "responses": { + "200": { + "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { + "post": { + "tags": [ + "BenefitUtilizationSummariesAsync" + ], + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanOrderId", + "description": "Triggers generation of a benefit utilization summaries report for the provided savings plan order.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "GenerateUtilizationSummariesReportBySavingsPlanOrder": { + "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/savingsPlanOrderIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "benefitUtilizationSummariesRequest", + "description": "Async Benefit Utilization Summary report to be created.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesRequest" + } + } + ], + "responses": { + "200": { + "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport": { + "post": { + "tags": [ + "BenefitUtilizationSummariesAsync" + ], + "operationId": "GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanId", + "description": "Triggers generation of a benefit utilization summaries report for the provided savings plan.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "GenerateUtilizationSummariesReportBySavingsPlan": { + "$ref": "./examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/savingsPlanOrderIdParameter" + }, + { + "$ref": "#/parameters/savingsPlanIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "benefitUtilizationSummariesRequest", + "description": "Async Benefit Utilization Summary report to be created.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesRequest" + } + } + ], + "responses": { + "200": { + "description": "The status of the generation of the benefit utilization summaries report. This could be in progress, failed, or completed.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesOperationStatus" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "benefitRecommendationsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The list of benefit recommendations.", + "readOnly": true, + "items": { + "$ref": "#/definitions/benefitRecommendationModel" + } + }, + "nextLink": { + "type": "string", + "description": "The link (URL) to the next page of results.", + "readOnly": true, + "format": "uri" + } + }, + "description": "Result of listing benefit recommendations." + }, + "benefitRecommendationModel": { + "type": "object", + "description": "benefit plan recommendation details.", + "allOf": [ + { + "$ref": "#/definitions/BenefitResource" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/benefitRecommendationProperties" + } + } + }, + "benefitRecommendationProperties": { + "type": "object", + "description": "The properties of the benefit recommendations.", + "discriminator": "scope", + "properties": { + "firstConsumptionDate": { + "type": "string", + "description": "The first usage date used for looking back for computing the recommendations.", + "readOnly": true, + "format": "date-time" + }, + "lastConsumptionDate": { + "type": "string", + "description": "The last usage date used for looking back for computing the recommendations.", + "readOnly": true, + "format": "date-time" + }, + "lookBackPeriod": { + "description": "The number of days of usage evaluated for computing the recommendations.", + "$ref": "#/definitions/LookBackPeriod" + }, + "totalHours": { + "type": "integer", + "format": "int32", + "description": "The total hours for which the cost is covered. Its equal to number of records in a property 'properties/usage/charges'.", + "readOnly": true + }, + "usage": { + "type": "object", + "description": "On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", + "$ref": "#/definitions/recommendationUsageDetails" + }, + "armSkuName": { + "description": "ARM SKU name. 'Compute_Savings_Plan' for SavingsPlan.", + "type": "string", + "readOnly": true + }, + "term": { + "description": "Term period of the benefit. For example, P1Y or P3Y.", + "$ref": "#/definitions/Term" + }, + "commitmentGranularity": { + "description": "Grain of the proposed commitment amount. Supported values: 'Hourly'", + "$ref": "#/definitions/Grain" + }, + "currencyCode": { + "type": "string", + "description": "An ISO 4217 currency code identifier for the costs and savings amounts.", + "readOnly": true + }, + "costWithoutBenefit": { + "type": "number", + "format": "decimal", + "description": "The current cost without benefit, corresponds to 'totalHours' in the look-back period.", + "readOnly": true + }, + "recommendationDetails": { + "type": "object", + "description": "The details of the proposed recommendation.", + "$ref": "#/definitions/allSavingsBenefitDetails" + }, + "allRecommendationDetails": { + "type": "object", + "description": "The list of all benefit recommendations with the recommendation details.", + "readOnly": true, + "$ref": "#/definitions/allSavingsList" + }, + "scope": { + "description": "Benefit scope. For example, Single or Shared.", + "$ref": "#/definitions/RecommendationScope" + } + }, + "required": [ + "scope" + ] + }, + "singleScopeBenefitRecommendationProperties": { + "type": "object", + "description": "The properties of the benefit recommendations when scope is 'Single'.", + "x-ms-discriminator-value": "Single", + "properties": { + "subscriptionId": { + "type": "string", + "description": "The subscription ID that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope.", + "readOnly": true + }, + "resourceGroup": { + "type": "string", + "description": "The resource group that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope and 'ResourceGroup' request scope.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/benefitRecommendationProperties" + } + ] + }, + "sharedScopeBenefitRecommendationProperties": { + "type": "object", + "description": "The properties of the benefit recommendation when scope is 'Shared'.", + "x-ms-discriminator-value": "Shared", + "allOf": [ + { + "$ref": "#/definitions/benefitRecommendationProperties" + } + ] + }, + "recommendationUsageDetails": { + "type": "object", + "description": "On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", + "properties": { + "usageGrain": { + "description": "The grain of the usage. Supported values: 'Hourly'", + "$ref": "#/definitions/Grain" + }, + "charges": { + "type": "array", + "description": "On-demand charges for each hour between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", + "readOnly": true, + "items": { + "type": "number", + "format": "decimal" + } + } + } + }, + "allSavingsList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The list of benefit recommendations with the recommendation details..", + "readOnly": true, + "items": { + "$ref": "#/definitions/allSavingsBenefitDetails" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link (URL) to the next page of results.", + "readOnly": true, + "format": "uri" + } + }, + "description": "The list of all benefit recommendations with the recommendation details." + }, + "allSavingsBenefitDetails": { + "description": "Benefit recommendation details.", + "type": "object", + "properties": { + "overageCost": { + "type": "number", + "format": "decimal", + "description": "The difference between total cost and benefit cost for the 'totalHours' in the look-back period.", + "readOnly": true + }, + "benefitCost": { + "type": "number", + "format": "decimal", + "description": "The estimated cost with benefit for the 'totalHours' in the look-back period. It's equal to (commitmentAmount * totalHours)", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "decimal", + "description": "Total cost, which is sum of benefit cost and overage cost.", + "readOnly": true + }, + "savingsAmount": { + "type": "number", + "format": "decimal", + "description": "The amount saved for the 'totalHours' in the look-back period, by purchasing the recommended quantity of the benefit.", + "readOnly": true + }, + "savingsPercentage": { + "type": "number", + "format": "decimal", + "description": "The savings in percentage for the 'totalHours' in the look-back period, by purchasing the recommended quantity of benefit.", + "readOnly": true + }, + "coveragePercentage": { + "description": "Estimated benefit coverage percentage for the 'totalHours' in the look-back period, with this commitment.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "commitmentAmount": { + "description": "The commitment amount at the commitmentGranularity.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "averageUtilizationPercentage": { + "description": "Estimated average utilization percentage for the 'totalHours' in the look-back period, with this commitment.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "wastageCost": { + "description": "Estimated unused portion of the 'benefitCost'.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "BenefitKind": { + "type": "string", + "description": "Kind/type of the benefit.", + "enum": [ + "IncludedQuantity", + "Reservation", + "SavingsPlan" + ], + "x-ms-enum": { + "name": "benefitKind", + "modelAsString": true, + "values": [ + { + "value": "IncludedQuantity", + "description": "Benefit is IncludedQuantity.", + "name": "IncludedQuantity" + }, + { + "value": "Reservation", + "description": "Benefit is Reservation.", + "name": "Reservation" + }, + { + "value": "SavingsPlan", + "description": "Benefit is SavingsPlan.", + "name": "SavingsPlan" + } + ] + } + }, + "RecommendationScope": { + "type": "string", + "description": "Kind of the recommendation scope.", + "enum": [ + "Single", + "Shared" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true, + "values": [ + { + "value": "Single", + "description": "Single scope recommendation.", + "name": "Single" + }, + { + "value": "Shared", + "description": "Shared scope recommendation.", + "name": "Shared" + } + ] + } + }, + "Grain": { + "type": "string", + "description": "Grain which corresponds to value.", + "enum": [ + "Hourly", + "Daily", + "Monthly" + ], + "x-ms-enum": { + "name": "grain", + "modelAsString": true, + "values": [ + { + "value": "Hourly", + "description": "Hourly grain corresponds to value per hour.", + "name": "Hourly" + }, + { + "value": "Daily", + "description": "Hourly grain corresponds to value per day.", + "name": "Daily" + }, + { + "value": "Monthly", + "description": "Hourly grain corresponds to value per month.", + "name": "Monthly" + } + ] + } + }, + "Term": { + "type": "string", + "description": "Grain which corresponds to value.", + "enum": [ + "P1Y", + "P3Y" + ], + "x-ms-enum": { + "name": "term", + "modelAsString": true, + "values": [ + { + "value": "P1Y", + "description": "Benefit term is 1 year.", + "name": "P1Y" + }, + { + "value": "P3Y", + "description": "Benefit term is 3 years.", + "name": "P3Y" + } + ] + } + }, + "LookBackPeriod": { + "type": "string", + "description": "The number of days used to look back.", + "enum": [ + "Last7Days", + "Last30Days", + "Last60Days" + ], + "x-ms-enum": { + "name": "lookBackPeriod", + "modelAsString": true, + "values": [ + { + "value": "Last7Days", + "description": "7 days used to look back.", + "name": "Last7Days" + }, + { + "value": "Last30Days", + "description": "30 days used to look back.", + "name": "Last30Days" + }, + { + "value": "Last60Days", + "description": "60 days used to look back.", + "name": "Last60Days" + } + ] + } + }, + "BenefitResource": { + "type": "object", + "description": "The benefit resource model definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "kind": { + "description": "Reservation or SavingsPlan.", + "$ref": "#/definitions/BenefitKind" + } + }, + "x-ms-azure-resource": true + }, + "BenefitUtilizationSummariesListResult": { + "description": "List of benefit utilization summaries.", + "type": "object", + "properties": { + "value": { + "description": "The list of benefit utilization summaries.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BenefitUtilizationSummary" + } + }, + "nextLink": { + "description": "The link (URL) to the next page of results.", + "type": "string", + "readOnly": true, + "format": "uri" + } + } + }, + "BenefitUtilizationSummary": { + "description": "Benefit utilization summary resource.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "kind": { + "description": "Supported values: 'SavingsPlan'.", + "$ref": "#/definitions/BenefitKind" + } + } + }, + "BenefitUtilizationSummaryProperties": { + "description": "The properties of a benefit utilization summary.", + "type": "object", + "properties": { + "armSkuName": { + "description": "ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan.", + "type": "string", + "readOnly": true + }, + "benefitId": { + "description": "The benefit ID is the identifier of the benefit.", + "type": "string", + "readOnly": true + }, + "benefitOrderId": { + "description": "The benefit order ID is the identifier for a benefit purchase.", + "type": "string", + "readOnly": true + }, + "benefitType": { + "description": "The benefit type. Supported values: 'SavingsPlan'.", + "$ref": "#/definitions/BenefitKind" + }, + "usageDate": { + "description": "Date corresponding to the utilization summary record. If the grain of data is monthly, value for this field will be first day of the month.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "IncludedQuantityUtilizationSummary": { + "description": "Included Quantity utilization summary resource.", + "x-ms-discriminator-value": "IncludedQuantity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BenefitUtilizationSummary" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IncludedQuantityUtilizationSummaryProperties", + "title": "Benefit utilization summary for benefit kind Included Quantity." + } + } + }, + "IncludedQuantityUtilizationSummaryProperties": { + "type": "object", + "description": "Included Quantity utilization summary properties.", + "allOf": [ + { + "$ref": "#/definitions/BenefitUtilizationSummaryProperties" + } + ], + "properties": { + "utilizationPercentage": { + "description": "This is the utilized percentage for the benefit ID.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "SavingsPlanUtilizationSummary": { + "description": "Savings plan utilization summary resource.", + "x-ms-discriminator-value": "SavingsPlan", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BenefitUtilizationSummary" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SavingsPlanUtilizationSummaryProperties", + "title": "Benefit utilization Summary for benefit kind savings plan." + } + } + }, + "SavingsPlanUtilizationSummaryProperties": { + "type": "object", + "description": "Savings plan utilization summary properties.", + "allOf": [ + { + "$ref": "#/definitions/BenefitUtilizationSummaryProperties" + } + ], + "properties": { + "avgUtilizationPercentage": { + "description": "This is the average hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-11-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the avgUtilizationPercentage value will be equal to the average of the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "minUtilizationPercentage": { + "description": "This is the minimum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-11-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the minUtilizationPercentage value will be equal to the smallest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the lowest utilization percentage was 10% at hour 4, then the value for the minUtilizationPercentage in the response will be 10%.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "maxUtilizationPercentage": { + "description": "This is the maximum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-11-01 and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the maxUtilizationPercentage value will be equal to the largest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the largest utilization percentage was 90% at hour 5, then the value for the maxUtilizationPercentage in the response will be 90%.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "BenefitUtilizationSummariesOperationStatus": { + "type": "object", + "description": "Status of a benefit utilization summaries report. Provides Async Benefit Utilization Summaries Request input, status, and report sas url.", + "properties": { + "input": { + "$ref": "#/definitions/BenefitUtilizationSummariesRequest", + "description": "Input given to create the benefit utilization summaries report." + }, + "status": { + "description": "The status of the creation of the benefit utilization summaries report.", + "$ref": "#/definitions/AsyncOperationStatusEnum" + }, + "properties": { + "description": "Contains sas url to the async benefit utilization summaries report and a date that the url is valid until. These values will be empty if the report is in a Running or Failed state", + "$ref": "#/definitions/AsyncOperationStatusProperties" + } + } + }, + "AsyncOperationStatusEnum": { + "description": "Enum representing the status of an async operation.", + "type": "string", + "enum": [ + "Running", + "Complete", + "Failed" + ], + "x-ms-enum": { + "name": "OperationStatusType", + "modelAsString": true + } + }, + "AsyncOperationStatusProperties": { + "description": "Object representing the report url and valid until date of the async report generated.", + "type": "object", + "properties": { + "reportUrl": { + "description": "Sas url to the async benefit utilization summaries report. Will be empty if the report is in Running or Failed state.", + "$ref": "#/definitions/BenefitUtilizationSummaryReportSchema", + "x-ms-secret": true + }, + "secondaryReportUrl": { + "description": "Sas url to async benefit utilization summaries report in secondary storage in case of primary outage. Will be empty if the report is in Running or Failed state.", + "$ref": "#/definitions/BenefitUtilizationSummaryReportSchema", + "x-ms-secret": true + }, + "validUntil": { + "description": "The date that the sas url provided in reportUrl expires.", + "type": "string", + "format": "date-time" + } + } + }, + "BenefitUtilizationSummaryReportSchema": { + "description": "The CSV file from the reportUrl and secondaryReportUrl blob link will consist of the following columns of benefit utilization data. UtilizedPercentage will be 0 for savings plans reports and non data bricks reservations. Utilization percentages will be 0 for data bricks reservations.", + "type": "string", + "enum": [ + "Kind", + "AvgUtilizationPercentage", + "BenefitOrderId", + "BenefitId", + "BenefitType", + "MaxUtilizationPercentage", + "MinUtilizationPercentage", + "UsageDate", + "UtilizedPercentage" + ], + "x-ms-enum": { + "name": "BenefitUtilizationSummaryReportSchema", + "modelAsString": true + } + }, + "BenefitUtilizationSummariesRequest": { + "description": "Properties of an async benefit utilization summaries request.", + "type": "object", + "required": [ + "startDate", + "endDate", + "grain" + ], + "properties": { + "billingAccountId": { + "description": "Billing account the benefit utilization summaries report is for. Required for billing account and billing profile scopes. Not supported for any benefit scopes.", + "type": "string" + }, + "billingProfileId": { + "description": "Billing profile id the benefit utilization summaries report is for. Required for billing profile scope. Not supported for billing account or any benefit scopes.", + "type": "string" + }, + "benefitOrderId": { + "description": "Benefit order id the benefit utilization summaries report is for. Required for benefit order and benefit id scopes. Not supported for any billing scopes.", + "type": "string" + }, + "benefitId": { + "description": "Benefit id the benefit utilization summaries report is for. Required for benefit id scope. Not supported for benefit order or any billing scopes.", + "type": "string" + }, + "grain": { + "description": "The grain the summaries data is served at in the report. Accepted values are 'Daily' or 'Monthly'.", + "$ref": "#/definitions/Grain" + }, + "startDate": { + "description": "The start date of the summaries data that will be served in the report.", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The end date of the summaries data that will be served in the report.", + "type": "string", + "format": "date-time" + }, + "kind": { + "description": "The type of benefit data requested. Required for billing account and billing profile scopes. Implied and not to be passed at benefit scopes. Supported values are Reservation and SavingsPlan", + "$ref": "#/definitions/BenefitKind" + } + } + } + }, + "parameters": { + "benefitAsyncOperationIdParameter": { + "description": "Operation id of the report being generated", + "in": "path", + "name": "operationId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "benefitRecommendationsFilterParameter": { + "name": "$filter", + "in": "query", + "description": "Can be used to filter benefitRecommendations by: properties/scope with allowed values ['Single', 'Shared'] and default value 'Shared'; and properties/lookBackPeriod with allowed values ['Last7Days', 'Last30Days', 'Last60Days'] and default value 'Last60Days'; properties/term with allowed values ['P1Y', 'P3Y'] and default value 'P3Y'; properties/subscriptionId; properties/resourceGroup", + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingScopeBenefitRecommendationParameter": { + "name": "billingScope", + "in": "path", + "description": "The scope associated with benefit recommendation operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for enterprise agreement scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "grainParameter": { + "description": "Grain.", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "type": "string", + "name": "grainParameter", + "enum": [ + "Hourly", + "Daily", + "Monthly" + ], + "x-ms-enum": { + "name": "grainParameter", + "modelAsString": true, + "values": [ + { + "value": "Hourly", + "description": "Hourly grain corresponds to value per hour.", + "name": "Hourly" + }, + { + "value": "Daily", + "description": "Hourly grain corresponds to value per day.", + "name": "Daily" + }, + { + "value": "Monthly", + "description": "Hourly grain corresponds to value per month.", + "name": "Monthly" + } + ] + } + }, + "reservationIdParameter": { + "description": "Reservation ID", + "in": "path", + "name": "reservationId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "reservationOrderIdParameter": { + "description": "Reservation Order ID", + "in": "path", + "name": "reservationOrderId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "savingsPlanIdParameter": { + "description": "Savings plan ID.", + "in": "path", + "name": "savingsPlanId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "savingsPlanOrderIdParameter": { + "description": "Savings plan order ID.", + "in": "path", + "name": "savingsPlanOrderId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.budgets.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.budgets.json new file mode 100644 index 000000000000..c59d0208524a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.budgets.json @@ -0,0 +1,768 @@ +{ + "swagger": "2.0", + "info": { + "title": "CostManagementClient", + "description": "CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions.", + "version": "2023-11-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.CostManagement/budgets": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_List", + "description": "Lists all budgets for the defined scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" + }, + "x-ms-examples": { + "SubscriptionBudgetsList": { + "$ref": "./examples/Budgets/List/RBAC/SubscriptionBudgetsList.json" + }, + "ResourceGroupBudgetsList": { + "$ref": "./examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json" + }, + "ManagementGroupBudgetsList": { + "$ref": "./examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json" + }, + "BillingAccountBudgetsList-EA": { + "$ref": "./examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json" + }, + "BillingAccountBudgetsList-EA-CategoryTypeFilter": { + "$ref": "./examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json" + }, + "DepartmentBudgetsList-EA": { + "$ref": "./examples/Budgets/List/EA/DepartmentBudgetsList.json" + }, + "EnrollmentAccountBudgetsList-EA": { + "$ref": "./examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json" + }, + "BillingAccountBudgetsList-MCA": { + "$ref": "./examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json" + }, + "BillingAccountBudgetsList-MCA-CategoryTypeFilter": { + "$ref": "./examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json" + }, + "BillingProfileBudgetsList-MCA": { + "$ref": "./examples/Budgets/List/MCA/BillingProfileBudgetsList.json" + }, + "BillingProfileBudgetsList-MCA-CategoryTypeFilter": { + "$ref": "./examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json" + }, + "InvoiceSectionBudgetsList-MCA": { + "$ref": "./examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json" + }, + "CustomerBudgetsList-MCA-CSP": { + "$ref": "./examples/Budgets/List/MCA/CustomerBudgetsList.json" + }, + "CustomerBudgetsList-MCA-CSP-CategoryTypeFilter": { + "$ref": "./examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/budgetCategoryFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BudgetsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_Get", + "description": "Gets the budget for the scope by budget name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" + }, + "x-ms-examples": { + "Get-Cost-Budget": { + "$ref": "./examples/Budgets/Get/Cost/Get-Cost-Budget.json" + }, + "Get-ReservationUtilization-AlertRule": { + "$ref": "./examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_CreateOrUpdate", + "description": "The operation to create or update a budget. You can optionally provide an eTag if desired as a form of concurrency control. To obtain the latest eTag for a given budget, perform a get operation prior to your put operation.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" + }, + "x-ms-examples": { + "CreateOrUpdate-Cost-Subscription-Budget": { + "$ref": "./examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule.json": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservedResourceTypeFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservationIdFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json" + }, + "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule.json": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json" + }, + "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservedResourceTypeFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json" + }, + "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservationIdFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Budget" + }, + "description": "Parameters supplied to the Create Budget operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded and the Budget update is complete.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_Delete", + "description": "The operation to delete a budget.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" + }, + "x-ms-examples": { + "DeleteBudget": { + "$ref": "./examples/Budgets/Delete/DeleteBudget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "BudgetsListResult": { + "description": "Result of listing budgets. It contains a list of available budgets in the scope provided.", + "type": "object", + "properties": { + "value": { + "description": "The list of budgets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Budget" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.\r\nIt's null for now, added for future use.", + "type": "string", + "readOnly": true + } + } + }, + "Budget": { + "description": "A budget resource.", + "type": "object", + "allOf": [ + { + "$ref": "common-types.json#/definitions/CostManagementProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BudgetProperties", + "title": "Budget properties" + } + } + }, + "BudgetProperties": { + "description": "The properties of the budget.", + "type": "object", + "properties": { + "category": { + "description": "The category of the budget.\n- 'Cost' defines a Budget.\n- 'ReservationUtilization' defines a Reservation Utilization Alert Rule.", + "type": "string", + "enum": [ + "Cost", + "ReservationUtilization" + ], + "x-ms-enum": { + "name": "CategoryType", + "modelAsString": true, + "values": [ + { + "value": "Cost", + "description": "A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold.", + "name": "Cost" + }, + { + "value": "ReservationUtilization", + "description": "An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold." + } + ] + } + }, + "amount": { + "description": "The total amount of cost to track with the budget.\n\n Supported for CategoryType(s): Cost.\n\n Required for CategoryType(s): Cost.", + "type": "number" + }, + "timeGrain": { + "description": "The time covered by a budget. Tracking of the amount will be reset based on the time grain.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\n Supported timeGrainTypes for **CategoryType: Cost**\n\n- Monthly\n- Quarterly\n- Annually\n- BillingMonth*\n- BillingQuarter*\n- BillingAnnual*\n\n *only supported for Web Direct customers.\n\n Supported timeGrainTypes for **CategoryType: ReservationUtilization**\n- Last7Days\n- Last30Days\n\n Required for CategoryType(s): Cost, ReservationUtilization.", + "type": "string", + "enum": [ + "Monthly", + "Quarterly", + "Annually", + "BillingMonth", + "BillingQuarter", + "BillingAnnual", + "Last7Days", + "Last30Days" + ], + "x-ms-enum": { + "name": "TimeGrainType", + "modelAsString": true, + "values": [ + { + "value": "Monthly", + "description": "The budget will track costs in the current calendar month against the amount.\n\n Supported for CategoryType: Cost only.", + "name": "Monthly" + }, + { + "value": "Quarterly", + "description": "The budget will track costs in the current calendar quarter against the amount.\n\n Supported for CategoryType: Cost only.", + "name": "Quarterly" + }, + { + "value": "Annually", + "description": "The budget will track costs in the current calendar year against the amount.\n\n Supported for CategoryType: Cost only.", + "name": "Annually" + }, + { + "value": "BillingMonth", + "description": "The budget will track costs in the current billing month against the amount.\n\n Supported for CategoryType: Cost and Web Direct customers only.", + "name": "BillingMonth" + }, + { + "value": "BillingQuarter", + "description": "The budget will track costs in the current billing quarter against the amount.\n\n Supported for CategoryType: Cost and Web Direct customers only.", + "name": "BillingQuarter" + }, + { + "value": "BillingAnnual", + "description": "The budget will track costs in the current billing year against the amount.\n\n Supported for CategoryType: Cost and Web Direct customers only.", + "name": "BillingAnnual" + }, + { + "value": "Last7Days", + "description": "The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage.\n\n Supported for CategoryType: ReservationUtilization only.", + "name": "Last7Days" + }, + { + "value": "Last30Days", + "description": "The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage.\n\n Supported for CategoryType: ReservationUtilization only.", + "name": "Last30Days" + } + ] + } + }, + "timePeriod": { + "description": "The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Required for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "$ref": "#/definitions/BudgetTimePeriod" + }, + "filter": { + "description": "May be used to filter budgets by user-specified dimensions and/or tags.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "$ref": "#/definitions/BudgetFilter" + }, + "currentSpend": { + "description": "The current amount of cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", + "$ref": "#/definitions/CurrentSpend", + "readOnly": true + }, + "notifications": { + "type": "object", + "description": "Dictionary of notifications associated with the budget.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n- Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.\n- Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable.", + "additionalProperties": { + "$ref": "#/definitions/Notification" + }, + "maxItems": 5 + }, + "forecastSpend": { + "description": "The forecasted cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", + "$ref": "#/definitions/ForecastSpend", + "readOnly": true + } + }, + "required": [ + "category", + "timeGrain", + "timePeriod" + ] + }, + "BudgetTimePeriod": { + "description": "The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Required for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "properties": { + "startDate": { + "description": "The start date for the budget.\n\n- Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.\n\n- Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date.", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The end date for the budget.\n\n- Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date.\n\n- Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "startDate" + ] + }, + "BudgetFilter": { + "description": "May be used to filter budgets by user-specified dimensions and/or tags.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.\n\n Supported for CategoryType(s): Cost.", + "type": "array", + "items": { + "$ref": "#/definitions/BudgetFilterProperties" + }, + "x-ms-identifiers": [], + "minItems": 0 + }, + "dimensions": { + "description": "Has comparison expression for a dimension.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization** \n- ReservationId\n- ReservedResourceType", + "$ref": "#/definitions/BudgetComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag.\n\n Supported for CategoryType(s): Cost.", + "$ref": "#/definitions/BudgetComparisonExpression" + } + } + }, + "BudgetFilterProperties": { + "description": "The Dimensions or Tags to filter a budget by.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "properties": { + "dimensions": { + "description": "Has comparison expression for a dimension.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization** \n- ReservationId\n- ReservedResourceType", + "$ref": "#/definitions/BudgetComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag.\n\n Supported for CategoryType(s): Cost.", + "$ref": "#/definitions/BudgetComparisonExpression" + } + } + }, + "BudgetComparisonExpression": { + "description": "The comparison expression to be used in the budgets.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "BudgetOperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "CurrentSpend": { + "description": "The current amount of cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", + "type": "object", + "properties": { + "amount": { + "description": "The total amount of cost which is being tracked by the budget.", + "type": "number", + "readOnly": true + }, + "unit": { + "description": "The unit of measure for the budget amount.", + "type": "string", + "readOnly": true + } + } + }, + "ForecastSpend": { + "description": "The forecasted cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", + "type": "object", + "properties": { + "amount": { + "description": "The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.", + "type": "number", + "readOnly": true + }, + "unit": { + "description": "The unit of measure for the budget amount.", + "type": "string", + "readOnly": true + } + } + }, + "Notification": { + "description": "The notification associated with a budget.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "properties": { + "enabled": { + "description": "The notification is enabled or not.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "boolean" + }, + "operator": { + "description": "The comparison operator.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Supported operators for **CategoryType: Cost**\n- GreaterThan\n- GreaterThanOrEqualTo\n\n Supported operators for **CategoryType: ReservationUtilization**\n- LessThan", + "type": "string", + "enum": [ + "EqualTo", + "GreaterThan", + "GreaterThanOrEqualTo", + "LessThan" + ], + "x-ms-enum": { + "name": "BudgetNotificationOperatorType", + "modelAsString": true, + "values": [ + { + "value": "EqualTo", + "description": "Notification will be triggered if the evaluated cost is the same as threshold value. Note: It’s not recommended to use this OperatorType as there’s low chance of cost being exactly the same as threshold value, leading to missing of your alert. This OperatorType will be deprecated in future.\n\n Supported for CategoryType(s): Cost.", + "name": "EqualTo" + }, + { + "value": "GreaterThan", + "description": "Notification will be triggered if the evaluated cost is greater than the threshold value. Note: This is the recommended OperatorType while configuring Budget Alert.\n\n Supported for CategoryType(s): Cost.", + "name": "GreaterThan" + }, + { + "value": "GreaterThanOrEqualTo", + "description": "Notification will be triggered if the evaluated cost is greater than or equal to the threshold value.\n\n Supported for CategoryType(s): Cost.", + "name": "GreaterThanOrEqualTo" + }, + { + "value": "LessThan", + "description": "Notification will be triggered if any Reservations in the scope of the Reservation Utilization Alert Rule have a utilization less than the threshold percentage.\n\n Supported for CategoryType(s): ReservationUtilization.", + "name": "LessThan" + } + ] + } + }, + "threshold": { + "description": "Threshold value associated with a notification. It is always percent with a maximum of 2 decimal places.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n **CategoryType: Cost** - Must be between 0 and 1000. Notification is sent when the cost exceeded the threshold.\n\n **CategoryType: ReservationUtilization** - Must be between 0 and 100. Notification is sent when a reservation has a utilization percentage below the threshold.", + "type": "number" + }, + "frequency": { + "description": "Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days).\n\n Supported for CategoryType(s): ReservationUtilization.", + "type": "string", + "enum": [ + "Daily", + "Weekly", + "Monthly" + ], + "x-ms-enum": { + "name": "Frequency", + "modelAsString": true, + "values": [ + { + "value": "Daily", + "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent until the next calendar day.", + "name": "Daily" + }, + { + "value": "Weekly", + "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent for 7 calendar days.", + "name": "Weekly" + }, + { + "value": "Monthly", + "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent for 30 calendar days.", + "name": "Monthly" + } + ] + } + }, + "contactEmails": { + "description": "Email addresses to send the notification to when the threshold is breached. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 50 + }, + "contactRoles": { + "description": "Subscription or Resource Group scopes only. Contact roles to send the notification to when the threshold is breached.\n\n Supported for CategoryType(s): Cost.", + "type": "array", + "items": { + "type": "string" + } + }, + "contactGroups": { + "description": "Subscription or Resource Group scopes only. Action groups to send the notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id.\n\n Supported for CategoryType(s): Cost.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 50 + }, + "thresholdType": { + "description": "The type of threshold.\n\n Supported for CategoryType(s): Cost.", + "type": "string", + "enum": [ + "Actual", + "Forecasted" + ], + "x-ms-enum": { + "name": "ThresholdType", + "modelAsString": true, + "values": [ + { + "value": "Actual", + "description": "Actual costs budget alerts notify when the actual accrued cost exceeds the allocated budget.", + "name": "Actual" + }, + { + "value": "Forecasted", + "description": "Forecasted costs budget alerts provide advanced notification that your spending trends are likely to exceed your allocated budget, as it relies on forecasted cost predictions.", + "name": "Forecasted" + } + ] + }, + "default": "Actual" + }, + "locale": { + "description": "Language in which the recipient will receive the notification, \n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "string", + "enum": [ + "en-us", + "ja-jp", + "zh-cn", + "de-de", + "es-es", + "fr-fr", + "it-it", + "ko-kr", + "pt-br", + "ru-ru", + "zh-tw", + "cs-cz", + "pl-pl", + "tr-tr", + "da-dk", + "en-gb", + "hu-hu", + "nb-no", + "nl-nl", + "pt-pt", + "sv-se" + ], + "x-ms-enum": { + "name": "CultureCode", + "modelAsString": true + } + } + }, + "required": [ + "enabled", + "operator", + "threshold", + "contactEmails" + ] + } + }, + "parameters": { + "scopeBudgetParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with budget operations.\n\n Supported scopes for **CategoryType: Cost**\n\n Azure RBAC Scopes:\n- '/subscriptions/{subscriptionId}/' for subscription scope\n- '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope\n- '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope\n\n EA (Enterprise Agreement) Scopes:\n\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope\n\n MCA (Modern Customer Agreement) Scopes:\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)\n\n Supported scopes for **CategoryType: ReservationUtilization**\n\n EA (Enterprise Agreement) Scopes:\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope\n\nMCA (Modern Customer Agreement) Scopes:\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only)\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "budgetNameParameter": { + "name": "budgetName", + "in": "path", + "description": "Budget Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9_-]+$", + "minLength": 1, + "maxLength": 63 + }, + "budgetCategoryFilterParameter": { + "name": "$filter", + "description": "OData filter option. May be used to filter budgets by properties/category. The filter supports 'eq' only.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.exports.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.exports.json new file mode 100644 index 000000000000..d3bb5107f196 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.exports.json @@ -0,0 +1,811 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01", + "title": "CostManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.CostManagement/exports": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_List", + "description": "The operation to list all exports at the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportsGetBySubscription": { + "$ref": "./examples/ExportsGetBySubscription.json" + }, + "ExportsGetByResourceGroup": { + "$ref": "./examples/ExportsGetByResourceGroup.json" + }, + "ExportsGetByBillingAccount": { + "$ref": "./examples/ExportsGetByBillingAccount.json" + }, + "ExportsGetByDepartment": { + "$ref": "./examples/ExportsGetByDepartment.json" + }, + "ExportsGetByEnrollmentAccount": { + "$ref": "./examples/ExportsGetByEnrollmentAccount.json" + }, + "ExportsGetByManagementGroup": { + "$ref": "./examples/ExportsGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last run of each export.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Get", + "description": "The operation to get the export for the defined scope by export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportGetBySubscription": { + "$ref": "./examples/ExportGetBySubscription.json" + }, + "ExportGetByResourceGroup": { + "$ref": "./examples/ExportGetByResourceGroup.json" + }, + "ExportGetByBillingAccount": { + "$ref": "./examples/ExportGetByBillingAccount.json" + }, + "ExportGetByDepartment": { + "$ref": "./examples/ExportGetByDepartment.json" + }, + "ExportGetByEnrollmentAccount": { + "$ref": "./examples/ExportGetByEnrollmentAccount.json" + }, + "ExportGetByManagementGroup": { + "$ref": "./examples/ExportGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last 10 runs of the export.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Exports" + ], + "operationId": "Exports_CreateOrUpdate", + "description": "The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportCreateOrUpdateBySubscription": { + "$ref": "./examples/ExportCreateOrUpdateBySubscription.json" + }, + "ExportCreateOrUpdateByResourceGroup": { + "$ref": "./examples/ExportCreateOrUpdateByResourceGroup.json" + }, + "ExportCreateOrUpdateByBillingAccount": { + "$ref": "./examples/ExportCreateOrUpdateByBillingAccount.json" + }, + "ExportCreateOrUpdateByDepartment": { + "$ref": "./examples/ExportCreateOrUpdateByDepartment.json" + }, + "ExportCreateOrUpdateByEnrollmentAccount": { + "$ref": "./examples/ExportCreateOrUpdateByEnrollmentAccount.json" + }, + "ExportCreateOrUpdateByManagementGroup": { + "$ref": "./examples/ExportCreateOrUpdateByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Export" + }, + "description": "Parameters supplied to the CreateOrUpdate Export operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Delete", + "description": "The operation to delete a export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportDeleteBySubscription": { + "$ref": "./examples/ExportDeleteBySubscription.json" + }, + "ExportDeleteByResourceGroup": { + "$ref": "./examples/ExportDeleteByResourceGroup.json" + }, + "ExportDeleteByBillingAccount": { + "$ref": "./examples/ExportDeleteByBillingAccount.json" + }, + "ExportDeleteByEnrollmentAccount": { + "$ref": "./examples/ExportDeleteByEnrollmentAccount.json" + }, + "ExportDeleteByDepartment": { + "$ref": "./examples/ExportDeleteByDepartment.json" + }, + "ExportDeleteByManagementGroup": { + "$ref": "./examples/ExportDeleteByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run": { + "post": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Execute", + "description": "The operation to run an export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportRunBySubscription": { + "$ref": "./examples/ExportRunBySubscription.json" + }, + "ExportRunByResourceGroup": { + "$ref": "./examples/ExportRunByResourceGroup.json" + }, + "ExportRunByBillingAccount": { + "$ref": "./examples/ExportRunByBillingAccount.json" + }, + "ExportRunByDepartment": { + "$ref": "./examples/ExportRunByDepartment.json" + }, + "ExportRunByEnrollmentAccount": { + "$ref": "./examples/ExportRunByEnrollmentAccount.json" + }, + "ExportRunByManagementGroup": { + "$ref": "./examples/ExportRunByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_GetExecutionHistory", + "description": "The operation to get the run history of an export for the defined scope and export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportRunHistoryGetBySubscription": { + "$ref": "./examples/ExportRunHistoryGetBySubscription.json" + }, + "ExportRunHistoryGetByResourceGroup": { + "$ref": "./examples/ExportRunHistoryGetByResourceGroup.json" + }, + "ExportRunHistoryGetByBillingAccount": { + "$ref": "./examples/ExportRunHistoryGetByBillingAccount.json" + }, + "ExportRunHistoryGetByDepartment": { + "$ref": "./examples/ExportRunHistoryGetByDepartment.json" + }, + "ExportRunHistoryGetByEnrollmentAccount": { + "$ref": "./examples/ExportRunHistoryGetByEnrollmentAccount.json" + }, + "ExportRunHistoryGetByManagementGroup": { + "$ref": "./examples/ExportRunHistoryGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportExecutionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ExportListResult": { + "description": "Result of listing exports. It contains a list of available exports in the scope provided.", + "type": "object", + "properties": { + "value": { + "description": "The list of exports.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Export" + } + } + } + }, + "Export": { + "description": "An export resource.", + "type": "object", + "allOf": [ + { + "$ref": "common-types.json#/definitions/CostManagementProxyResource" + } + ], + "properties": { + "identity": { + "description": "The managed identity associated with Export", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/SystemAssignedServiceIdentity" + }, + "location": { + "type": "string", + "description": "The location of the Export's managed identity. Only required when utilizing managed identity.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportProperties", + "title": "Export properties" + } + } + }, + "ExportProperties": { + "description": "The properties of the export.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonExportProperties" + } + ], + "properties": { + "schedule": { + "description": "Has schedule information for the export.", + "$ref": "#/definitions/ExportSchedule" + } + } + }, + "CommonExportProperties": { + "description": "The common properties of the export.", + "type": "object", + "properties": { + "format": { + "description": "The format of the export being delivered. Currently only 'Csv' is supported.", + "type": "string", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "FormatType", + "modelAsString": true + } + }, + "deliveryInfo": { + "description": "Has delivery information for the export.", + "$ref": "#/definitions/ExportDeliveryInfo" + }, + "definition": { + "description": "Has the definition for the export.", + "$ref": "#/definitions/ExportDefinition" + }, + "runHistory": { + "description": "If requested, has the most recent run history for the export.", + "$ref": "#/definitions/ExportExecutionListResult" + }, + "partitionData": { + "description": "If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for Microsoft Customer Agreement commerce scopes.", + "type": "boolean" + }, + "nextRunTimeEstimate": { + "description": "If the export has an active schedule, provides an estimate of the next run time.", + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "deliveryInfo", + "definition" + ] + }, + "ExportSchedule": { + "description": "The schedule associated with the export.", + "type": "object", + "properties": { + "status": { + "description": "The status of the export's schedule. If 'Inactive', the export's schedule is paused.", + "type": "string", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "StatusType", + "modelAsString": true + } + }, + "recurrence": { + "description": "The schedule recurrence.", + "type": "string", + "enum": [ + "Daily", + "Weekly", + "Monthly", + "Annually" + ], + "x-ms-enum": { + "name": "RecurrenceType", + "modelAsString": true + } + }, + "recurrencePeriod": { + "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.", + "$ref": "#/definitions/ExportRecurrencePeriod" + } + } + }, + "ExportDeliveryInfo": { + "description": "The delivery information associated with a export.", + "type": "object", + "properties": { + "destination": { + "description": "Has destination for the export being delivered.", + "$ref": "#/definitions/ExportDeliveryDestination" + } + }, + "required": [ + "destination" + ] + }, + "ExportRecurrencePeriod": { + "description": "The start and end date for recurrence schedule.", + "type": "object", + "properties": { + "from": { + "description": "The start date of recurrence.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date of recurrence.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from" + ] + }, + "ExportDeliveryDestination": { + "description": "This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource id of the storage account where exports will be delivered. This is not required if a sasToken and storageAccount are specified.", + "type": "string" + }, + "container": { + "description": "The name of the container where exports will be uploaded. If the container does not exist it will be created.", + "type": "string" + }, + "rootFolderPath": { + "description": "The name of the directory where exports will be uploaded.", + "type": "string" + }, + "sasToken": { + "description": "A SAS token for the storage account. For a restricted set of Azure customers this together with storageAccount can be specified instead of resourceId. Note: the value returned by the API for this property will always be obfuscated. Returning this same obfuscated value will not result in the SAS token being updated. To update this value a new SAS token must be specified.", + "type": "string", + "x-ms-secret": true + }, + "storageAccount": { + "description": "The storage account where exports will be uploaded. For a restricted set of Azure customers this together with sasToken can be specified instead of resourceId.", + "type": "string" + } + }, + "required": [ + "container" + ] + }, + "ExportDefinition": { + "description": "The definition of an export.", + "type": "object", + "properties": { + "type": { + "description": "The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ExportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the export. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "MonthToDate", + "BillingMonthToDate", + "TheLastMonth", + "TheLastBillingMonth", + "WeekToDate", + "Custom" + ], + "x-ms-enum": { + "name": "TimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the export.", + "$ref": "#/definitions/ExportTimePeriod" + }, + "dataSet": { + "description": "The definition for data in the export.", + "$ref": "#/definitions/ExportDataset" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "ExportDataset": { + "description": "The definition for data in the export.", + "type": "object", + "properties": { + "granularity": { + "description": "The granularity of rows in the export. Currently only 'Daily' is supported.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "The export dataset configuration.", + "$ref": "#/definitions/ExportDatasetConfiguration" + } + } + }, + "ExportDatasetConfiguration": { + "description": "The export dataset configuration. Allows columns to be selected for the export. If not provided then the export will include all available columns.", + "type": "object", + "properties": { + "columns": { + "description": "Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples).", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ExportTimePeriod": { + "description": "The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months.", + "type": "object", + "properties": { + "from": { + "description": "The start date for export data.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date for export data.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ExportExecutionListResult": { + "description": "Result of listing the run history of an export.", + "type": "object", + "properties": { + "value": { + "description": "A list of export runs.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExportRun" + } + } + } + }, + "ExportRun": { + "description": "An export run.", + "type": "object", + "allOf": [ + { + "$ref": "common-types.json#/definitions/CostManagementProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportRunProperties", + "title": "Export run properties" + } + } + }, + "ExportRunProperties": { + "description": "The properties of the export run.", + "type": "object", + "properties": { + "executionType": { + "description": "The type of the export run.", + "type": "string", + "enum": [ + "OnDemand", + "Scheduled" + ], + "x-ms-enum": { + "name": "ExecutionType", + "modelAsString": true + } + }, + "status": { + "description": "The last known status of the export run.", + "type": "string", + "enum": [ + "Queued", + "InProgress", + "Completed", + "Failed", + "Timeout", + "NewDataNotAvailable", + "DataNotAvailable" + ], + "x-ms-enum": { + "name": "ExecutionStatus", + "modelAsString": true + } + }, + "submittedBy": { + "description": "The identifier for the entity that triggered the export. For on-demand runs it is the user email. For scheduled runs it is 'System'.", + "type": "string" + }, + "submittedTime": { + "description": "The time when export was queued to be run.", + "type": "string", + "format": "date-time" + }, + "processingStartTime": { + "description": "The time when export was picked up to be run.", + "type": "string", + "format": "date-time" + }, + "processingEndTime": { + "description": "The time when the export run finished.", + "type": "string", + "format": "date-time" + }, + "fileName": { + "description": "The name of the exported file.", + "type": "string" + }, + "runSettings": { + "description": "The export settings that were in effect for this run.", + "$ref": "#/definitions/CommonExportProperties" + }, + "error": { + "description": "The details of any error.", + "$ref": "common-types.json#/definitions/ErrorDetails" + } + } + } + }, + "parameters": { + "scopeExportParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "exportNameParameter": { + "name": "exportName", + "in": "path", + "description": "Export Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatecostdetailsreport.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatecostdetailsreport.json new file mode 100644 index 000000000000..df9293ff86e7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatecostdetailsreport.json @@ -0,0 +1,405 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01", + "title": "CostManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport": { + "post": { + "tags": [ + "CostDetails" + ], + "operationId": "GenerateCostDetailsReport_CreateOperation", + "description": "This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body. To Understand cost details (formerly known as usage details) fields found in files ,see https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "GenerateCostDetailsReportByBillingProfileAndInvoiceId": { + "$ref": "./examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json" + }, + "GenerateCostDetailsReportBySubscriptionAndTimePeriod": { + "$ref": "./examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json" + }, + "GenerateCostDetailsReportByCustomerAndTimePeriod": { + "$ref": "./examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json" + }, + "GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId": { + "$ref": "./examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json" + }, + "GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod": { + "$ref": "./examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json" + }, + "GenerateCostDetailsReportByDepartmentsAndTimePeriod": { + "$ref": "./examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json" + }, + "GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod": { + "$ref": "./examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateCostDetailsReportRequestDefinition" + }, + "description": "Parameters supplied to the Create cost details operation." + } + ], + "responses": { + "200": { + "description": "Request processing completed.", + "schema": { + "$ref": "#/definitions/CostDetailsOperationResults" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the Location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the result of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "204": { + "description": "No Content. The request has succeeded but returned no results." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GenerateCostDetailsReportErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}": { + "get": { + "tags": [ + "CostDetails" + ], + "operationId": "GenerateCostDetailsReport_GetOperationResults", + "description": "Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.", + "x-ms-examples": { + "Get details of the operation result": { + "$ref": "./examples/CostDetailsOperationResultsBySubscriptionScope.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The target operation Id." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CostDetailsOperationResults" + } + }, + "202": { + "description": "Accepted. The operation is ongoing." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "GenerateCostDetailsReportErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 400 Bad Request - Invalid Request Payload. Request payload provided is not in a json format or had an invalid member not accepted in the request payload. \n\n * 400 Bad Request - Invalid request payload: can only have either timePeriod or invoiceId or billingPeriod. API only allows data to be pulled for either timePeriod or invoiceId or billingPeriod. Customer should provide only one of these parameters. \n\n * 400 Bad Request - Start date must be after . API only allows data to be pulled no older than 13 months from now. \n\n * 400 Bad Request - The maximum allowed date range is 1 months. API only allows data to be pulled for 1 month or less. \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "common-types.json#/definitions/ErrorDetails" + } + } + }, + "GenerateCostDetailsReportRequestDefinition": { + "description": "The definition of a cost detailed report.", + "type": "object", + "properties": { + "metric": { + "description": "The type of the detailed report. By default ActualCost is provided", + "type": "string", + "enum": [ + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "CostDetailsMetricType", + "modelAsString": true, + "values": [ + { + "value": "ActualCost", + "description": "Actual cost data.", + "name": "ActualCostCostDetailsMetricType" + }, + { + "value": "AmortizedCost", + "description": "Amortized cost data.", + "name": "AmortizedCostCostDetailsMetricType" + } + ] + } + }, + "timePeriod": { + "description": "The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period", + "$ref": "#/definitions/CostDetailsTimePeriod" + }, + "billingPeriod": { + "description": "This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost.", + "type": "string" + }, + "invoiceId": { + "description": "This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost.", + "type": "string" + } + } + }, + "CostDetailsTimePeriod": { + "description": "The start and end date for pulling data for the cost detailed report. API only allows data to be pulled for 1 month or less and no older than 13 months.", + "type": "object", + "properties": { + "start": { + "description": "The start date to pull data from. example format 2020-03-15", + "type": "string" + }, + "end": { + "description": "The end date to pull data to. example format 2020-03-15", + "type": "string" + } + }, + "required": [ + "start", + "end" + ] + }, + "CostDetailsOperationResults": { + "description": "The result of the long running operation for cost details Api.", + "type": "object", + "properties": { + "id": { + "description": "The id of the long running operation.", + "type": "string" + }, + "name": { + "description": "The name of the long running operation.", + "type": "string" + }, + "type": { + "description": "The type of the long running operation.", + "type": "string" + }, + "status": { + "description": "The status of the cost details operation", + "type": "string", + "enum": [ + "Completed", + "NoDataFound", + "Failed" + ], + "x-ms-enum": { + "name": "CostDetailsStatusType", + "modelAsString": true, + "values": [ + { + "value": "Completed", + "description": "Operation is Completed.", + "name": "CompletedCostDetailsStatusType" + }, + { + "value": "NoDataFound", + "description": "Operation is Completed and no cost data found.", + "name": "NoDataFoundCostDetailsStatusType" + }, + { + "value": "Failed", + "description": "Operation Failed.", + "name": "FailedCostDetailsStatusType" + } + ] + } + }, + "manifest": { + "x-ms-client-flatten": true, + "description": "The manifest of the report generated by the operation.", + "$ref": "#/definitions/ReportManifest" + }, + "validTill": { + "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", + "type": "string", + "format": "date-time" + }, + "error": { + "description": "The details of the error.", + "$ref": "common-types.json#/definitions/ErrorDetails" + } + } + }, + "ReportManifest": { + "description": "The manifest of the report generated by the operation.", + "type": "object", + "properties": { + "manifestVersion": { + "description": "The Manifest version.", + "type": "string" + }, + "dataFormat": { + "description": "The data format of the report", + "type": "string", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "CostDetailsDataFormat", + "modelAsString": true, + "values": [ + { + "value": "Csv", + "description": "Csv data format.", + "name": "CsvCostDetailsDataFormat" + } + ] + } + }, + "byteCount": { + "description": "The total number of bytes in all blobs.", + "format": "int64", + "type": "integer" + }, + "blobCount": { + "description": "The total number of blobs.", + "format": "int32", + "type": "integer" + }, + "compressData": { + "description": "Is the data in compressed format.", + "type": "boolean" + }, + "requestContext": { + "x-ms-client-flatten": true, + "description": "The context of the Cost Details request.", + "$ref": "#/definitions/RequestContext" + }, + "blobs": { + "description": "List of blob information generated by this operation.", + "type": "array", + "items": { + "$ref": "#/definitions/BlobInfo" + }, + "x-ms-identifiers": [ + "blobLink" + ] + } + } + }, + "RequestContext": { + "description": "The context of the Cost Details request.", + "type": "object", + "properties": { + "requestScope": { + "description": "The request scope of the request.", + "type": "string" + }, + "requestBody": { + "description": "The request payload body provided in Cost Details call", + "$ref": "#/definitions/GenerateCostDetailsReportRequestDefinition" + } + } + }, + "BlobInfo": { + "description": "The blob information generated by this operation.", + "type": "object", + "properties": { + "blobLink": { + "description": "Link to the blob to download file.", + "type": "string" + }, + "byteCount": { + "description": "Bytes in the blob.", + "format": "int64", + "type": "integer" + } + } + } + }, + "parameters": { + "scopeUsageDetailsParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The ARM Resource ID for subscription, billing account, or other billing scopes.Currently Resource Group and Management Group are not supported. For details, see https://aka.ms/costmgmt/scopes.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatedetailedcostreport.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatedetailedcostreport.json new file mode 100644 index 000000000000..c38b4e42d4ea --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatedetailedcostreport.json @@ -0,0 +1,368 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01", + "title": "CostManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport": { + "post": { + "tags": [ + "UsageDetails" + ], + "operationId": "GenerateDetailedCostReport_CreateOperation", + "description": "Generates the detailed cost report for provided date range, billing period(only enterprise customers) or Invoice ID asynchronously at a certain scope. Call returns a 202 with header Azure-Consumption-AsyncOperation providing a link to the operation created. A call on the operation will provide the status and if the operation is completed the blob file where generated detailed cost report is being stored.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "GenerateDetailedCostReportByBillingProfileAndInvoiceId": { + "$ref": "./examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json" + }, + "GenerateDetailedCostReportBySubscriptionAndTimePeriod": { + "$ref": "./examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json" + }, + "GenerateDetailedCostReportByCustomerAndTimePeriod": { + "$ref": "./examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json" + }, + "GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId": { + "$ref": "./examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json" + }, + "GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod": { + "$ref": "./examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateDetailedCostReportDefinition" + }, + "description": "Parameters supplied to the Create detailed cost report operation." + } + ], + "responses": { + "200": { + "description": "Request processing completed.", + "schema": { + "$ref": "#/definitions/GenerateDetailedCostReportOperationResult" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the Location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the result of the asynchronous operation.", + "type": "string" + }, + "Azure-Consumption-AsyncOperation": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GenerateDetailedCostReportErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/operationResults/{operationId}": { + "get": { + "tags": [ + "GenerateDetailedCostReportOperationResults" + ], + "operationId": "GenerateDetailedCostReportOperationResults_Get", + "description": "Gets the result of the specified operation. The link with this operationId is provided as a response header of the initial request.", + "x-ms-examples": { + "Get details of the operation result": { + "$ref": "./examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The target operation Id." + }, + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/GenerateDetailedCostReportOperationResult" + } + }, + "202": { + "description": "Accepted. The operation is ongoing." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/operationStatus/{operationId}": { + "get": { + "tags": [ + "GenerateDetailedCostReportOperationStatus" + ], + "operationId": "GenerateDetailedCostReportOperationStatus_Get", + "description": "Get the status of the specified operation. This link is provided in the GenerateDetailedCostReport creation request response header.", + "x-ms-examples": { + "Get details of the operation status": { + "$ref": "./examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json" + } + }, + "parameters": [ + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The target operation Id." + }, + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/GenerateDetailedCostReportOperationStatuses" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "GenerateDetailedCostReportErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 413 Request Entity Too Large - Request is throttled. The amount of data required to fulfill the request exceeds the maximum size permitted of 2Gb. Please utilize our Exports feature instead. \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "common-types.json#/definitions/ErrorDetails" + } + } + }, + "GenerateDetailedCostReportDefinition": { + "description": "The definition of a cost detailed report.", + "properties": { + "metric": { + "description": "The type of the detailed report. By default ActualCost is provided", + "type": "string", + "enum": [ + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "GenerateDetailedCostReportMetricType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the cost detailed report. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided.", + "$ref": "#/definitions/GenerateDetailedCostReportTimePeriod" + }, + "billingPeriod": { + "description": "Billing period in YearMonth(e.g. 202008) format. Only for legacy enterprise customers can use this. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided.", + "type": "string" + }, + "invoiceId": { + "description": "Invoice ID for Pay-as-you-go and Microsoft Customer Agreement scopes. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided.", + "type": "string" + }, + "customerId": { + "description": "Customer ID for Microsoft Customer Agreement scopes (Invoice Id is also required for this).", + "type": "string" + } + } + }, + "GenerateDetailedCostReportTimePeriod": { + "description": "The start and end date for pulling data for the cost detailed report.", + "properties": { + "start": { + "description": "The start date to pull data from. example format 2020-03-15", + "type": "string" + }, + "end": { + "description": "The end date to pull data to. example format 2020-03-15", + "type": "string" + } + }, + "required": [ + "start", + "end" + ] + }, + "GenerateDetailedCostReportOperationStatuses": { + "description": "The status of the long running operation for cost detailed report.", + "properties": { + "id": { + "description": "The ID of the long running operation.", + "type": "string" + }, + "name": { + "description": "The name of the long running operation.", + "type": "string" + }, + "status": { + "description": "The status of the long running operation.", + "$ref": "#/definitions/Status" + }, + "startTime": { + "description": "The startTime of the operation.", + "type": "string" + }, + "endTime": { + "description": "The endTime of the operation.", + "type": "string" + }, + "type": { + "description": "The type of the long running operation.", + "type": "string" + }, + "error": { + "description": "The details of the error.", + "$ref": "common-types.json#/definitions/ErrorDetails" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the usage file generated.", + "$ref": "common-types.json#/definitions/DownloadURL" + } + } + }, + "GenerateDetailedCostReportOperationResult": { + "description": "The result of the long running operation for cost detailed report.", + "properties": { + "id": { + "description": "The ARM resource id of the long running operation.", + "type": "string" + }, + "name": { + "description": "The name of the long running operation.", + "type": "string" + }, + "type": { + "description": "The type of the long running operation.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the resource generated.", + "$ref": "common-types.json#/definitions/DownloadURL" + } + } + }, + "Status": { + "description": "The status of the long running operation.", + "properties": { + "status": { + "description": "The status of the long running operation.", + "type": "string", + "enum": [ + "InProgress", + "Completed", + "Failed", + "Queued", + "NoDataFound", + "ReadyToDownload", + "TimedOut" + ], + "x-ms-enum": { + "name": "ReportOperationStatusType", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "scopeUsageDetailsParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.json new file mode 100644 index 000000000000..9346d070efb4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.json @@ -0,0 +1,2979 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01", + "title": "CostManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.CostManagement/views": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_List", + "description": "Lists all views by tenant and object.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "PrivateViewList": { + "$ref": "./examples/PrivateViewList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ViewListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/views": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_ListByScope", + "description": "Lists all views at the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupViewList": { + "$ref": "./examples/ViewListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ViewListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.CostManagement/views/{viewName}": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_Get", + "description": "Gets the view by view name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "PrivateView": { + "$ref": "./examples/PrivateView.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Views" + ], + "operationId": "Views_CreateOrUpdate", + "description": "The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "CreateOrUpdatePrivateView": { + "$ref": "./examples/PrivateViewCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/View" + }, + "description": "Parameters supplied to the CreateOrUpdate View operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Views" + ], + "operationId": "Views_Delete", + "description": "The operation to delete a view.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "DeletePrivateView": { + "$ref": "./examples/PrivateViewDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/views/{viewName}": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_GetByScope", + "description": "Gets the view for the defined scope by view name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupView": { + "$ref": "./examples/ViewByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Views" + ], + "operationId": "Views_CreateOrUpdateByScope", + "description": "The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupCreateOrUpdateView": { + "$ref": "./examples/ViewCreateOrUpdateByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/View" + }, + "description": "Parameters supplied to the CreateOrUpdate View operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Views" + ], + "operationId": "Views_DeleteByScope", + "description": "The operation to delete a view.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupDeleteView": { + "$ref": "./examples/ViewDeleteByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_List", + "description": "Lists the alerts for scope defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "BillingAccountAlerts": { + "$ref": "./examples/BillingAccountAlerts.json" + }, + "BillingProfileAlerts": { + "$ref": "./examples/BillingProfileAlerts.json" + }, + "InvoiceSectionAlerts": { + "$ref": "./examples/InvoiceSectionAlerts.json" + }, + "EnrollmentAccountAlerts": { + "$ref": "./examples/EnrollmentAccountAlerts.json" + }, + "DepartmentAlerts": { + "$ref": "./examples/DepartmentAlerts.json" + }, + "SubscriptionAlerts": { + "$ref": "./examples/SubscriptionAlerts.json" + }, + "ResourceGroupAlerts": { + "$ref": "./examples/ResourceGroupAlerts.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_Get", + "description": "Gets the alert for the scope by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SingleSubscriptionAlerts": { + "$ref": "./examples/SingleSubscriptionAlert.json" + }, + "SingleResourceGroupAlerts": { + "$ref": "./examples/SingleResourceGroupAlert.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_Dismiss", + "description": "Dismisses the specified alert", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "PatchSubscriptionAlerts": { + "$ref": "./examples/DismissSubscriptionAlerts.json" + }, + "PatchResourceGroupAlerts": { + "$ref": "./examples/DismissResourceGroupAlerts.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DismissAlertPayload" + }, + "description": "Parameters supplied to the Dismiss Alert operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_ListExternal", + "description": "Lists the Alerts for external cloud provider type defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountAlerts": { + "$ref": "./examples/ExternalBillingAccountAlerts.json" + }, + "ExternalSubscriptionAlerts": { + "$ref": "./examples/ExternalSubscriptionAlerts.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_Usage", + "description": "Lists the forecast charges for scope defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "BillingAccountForecast": { + "$ref": "./examples/BillingAccountForecast.json" + }, + "BillingProfileForecast": { + "$ref": "./examples/BillingProfileForecast.json" + }, + "InvoiceSectionForecast": { + "$ref": "./examples/InvoiceSectionForecast.json" + }, + "EnrollmentAccountForecast": { + "$ref": "./examples/EnrollmentAccountForecast.json" + }, + "DepartmentForecast": { + "$ref": "./examples/DepartmentForecast.json" + }, + "SubscriptionForecast": { + "$ref": "./examples/SubscriptionForecast.json" + }, + "ResourceGroupForecast": { + "$ref": "./examples/ResourceGroupForecast.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/scopeForecastParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForecastDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Forecast Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ForecastResult" + } + }, + "204": { + "description": "No Content. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_ExternalCloudProviderUsage", + "description": "Lists the forecast charges for external cloud provider type defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountForecast": { + "$ref": "./examples/ExternalBillingAccountForecast.json" + }, + "ExternalSubscriptionForecast": { + "$ref": "./examples/ExternalSubscriptionForecast.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForecastDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Forecast Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ForecastResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_List", + "description": "Lists the dimensions by the defined scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionDimensionsList-Legacy": { + "$ref": "./examples/SubscriptionDimensionsList.json" + }, + "ResourceGroupDimensionsList-Legacy": { + "$ref": "./examples/ResourceGroupDimensionsList.json" + }, + "ManagementGroupDimensionsList-Legacy": { + "$ref": "./examples/ManagementGroupDimensionsList.json" + }, + "ManagementGroupDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/ManagementGroupDimensionsListExpandAndTop.json" + }, + "ManagementGroupDimensionsListWithFilter-Legacy": { + "$ref": "./examples/ManagementGroupDimensionsListWithFilter.json" + }, + "DepartmentDimensionsList-Legacy": { + "$ref": "./examples/DepartmentDimensionsList.json" + }, + "DepartmentDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/DepartmentDimensionsListExpandAndTop.json" + }, + "DepartmentDimensionsListWithFilter-Legacy": { + "$ref": "./examples/DepartmentDimensionsListWithFilter.json" + }, + "EnrollmentAccountDimensionsList-Legacy": { + "$ref": "./examples/EnrollmentAccountDimensionsList.json" + }, + "EnrollmentAccountDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/EnrollmentAccountDimensionsListExpandAndTop.json" + }, + "EnrollmentAccountDimensionsListWithFilter-Legacy": { + "$ref": "./examples/EnrollmentAccountDimensionsListWithFilter.json" + }, + "BillingAccountDimensionsList-Legacy": { + "$ref": "./examples/BillingAccountDimensionsList.json" + }, + "BillingAccountDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/BillingAccountDimensionsListExpandAndTop.json" + }, + "BillingAccountDimensionsListWithFilter-Legacy": { + "$ref": "./examples/BillingAccountDimensionsListWithFilter.json" + }, + "BillingAccountDimensionsList-MCA": { + "$ref": "./examples/MCABillingAccountDimensionsList.json" + }, + "BillingAccountDimensionsListExpandAndTop-MCA": { + "$ref": "./examples/MCABillingAccountDimensionsListExpandAndTop.json" + }, + "BillingAccountDimensionsListWithFilter-MCA": { + "$ref": "./examples/MCABillingAccountDimensionsListWithFilter.json" + }, + "BillingProfileDimensionsList-MCA": { + "$ref": "./examples/MCABillingProfileDimensionsList.json" + }, + "BillingProfileDimensionsListExpandAndTop-MCA": { + "$ref": "./examples/MCABillingProfileDimensionsListExpandAndTop.json" + }, + "BillingProfileDimensionsListWithFilter-MCA": { + "$ref": "./examples/MCABillingProfileDimensionsListWithFilter.json" + }, + "InvoiceSectionDimensionsList-MCA": { + "$ref": "./examples/MCAInvoiceSectionDimensionsList.json" + }, + "InvoiceSectionDimensionsListExpandAndTop-MCA": { + "$ref": "./examples/MCAInvoiceSectionDimensionsListExpandAndTop.json" + }, + "InvoiceSectionDimensionsListWithFilter-MCA": { + "$ref": "./examples/MCAInvoiceSectionDimensionsListWithFilter.json" + }, + "CustomerDimensionsList-MCA": { + "$ref": "./examples/MCACustomerDimensionsList.json" + }, + "CustomerDimensionsListExpandAndTop-MCA": { + "$ref": "./examples/MCACustomerDimensionsListExpandAndTop.json" + }, + "CustomerDimensionsListWithFilter-MCA": { + "$ref": "./examples/MCACustomerDimensionsListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeDimensionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionsListResult" + } + }, + "204": { + "description": "No Content. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_ByExternalCloudProviderType", + "description": "Lists the dimensions by the external cloud provider type.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountDimensionList": { + "$ref": "./examples/ExternalBillingAccountsDimensions.json" + }, + "ExternalSubscriptionDimensionList": { + "$ref": "./examples/ExternalSubscriptionsDimensions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_Usage", + "description": "Query the usage data for scope defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionQuery-Legacy": { + "$ref": "./examples/SubscriptionQuery.json" + }, + "SubscriptionQueryGrouping-Legacy": { + "$ref": "./examples/SubscriptionQueryGrouping.json" + }, + "ResourceGroupQuery-Legacy": { + "$ref": "./examples/ResourceGroupQuery.json" + }, + "ResourceGroupQueryGrouping-Legacy": { + "$ref": "./examples/ResourceGroupQueryGrouping.json" + }, + "BillingAccountQuery-Legacy": { + "$ref": "./examples/BillingAccountQuery.json" + }, + "BillingAccountQueryGrouping-Legacy": { + "$ref": "./examples/BillingAccountQueryGrouping.json" + }, + "EnrollmentAccountQuery-Legacy": { + "$ref": "./examples/EnrollmentAccountQuery.json" + }, + "EnrollmentAccountQueryGrouping-Legacy": { + "$ref": "./examples/EnrollmentAccountQueryGrouping.json" + }, + "DepartmentQuery-Legacy": { + "$ref": "./examples/DepartmentQuery.json" + }, + "DepartmentQueryGrouping-Legacy": { + "$ref": "./examples/DepartmentQueryGrouping.json" + }, + "ManagementGroupQuery-Legacy": { + "$ref": "./examples/ManagementGroupQuery.json" + }, + "ManagementGroupQueryGrouping-Legacy": { + "$ref": "./examples/ManagementGroupQueryGrouping.json" + }, + "BillingAccountQuery-MCA": { + "$ref": "./examples/MCABillingAccountQuery.json" + }, + "BillingAccountQueryGrouping-MCA": { + "$ref": "./examples/MCABillingAccountQueryGrouping.json" + }, + "BillingProfileQuery-MCA": { + "$ref": "./examples/MCABillingProfileQuery.json" + }, + "BillingProfileQueryGrouping-MCA": { + "$ref": "./examples/MCABillingProfileQueryGrouping.json" + }, + "InvoiceSectionQuery-MCA": { + "$ref": "./examples/MCAInvoiceSectionQuery.json" + }, + "InvoiceSectionQueryGrouping-MCA": { + "$ref": "./examples/MCAInvoiceSectionQueryGrouping.json" + }, + "CustomerQuery-MCA": { + "$ref": "./examples/MCACustomerQuery.json" + }, + "CustomerQueryGrouping-MCA": { + "$ref": "./examples/MCACustomerQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Query Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "204": { + "description": "No Content. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_UsageByExternalCloudProviderType", + "description": "Query the usage data for external cloud provider type defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountQueryList": { + "$ref": "./examples/ExternalBillingAccountsQuery.json" + }, + "ExternalSubscriptionsQuery": { + "$ref": "./examples/ExternalSubscriptionsQuery.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Query Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport": { + "post": { + "tags": [ + "ReservedInstances" + ], + "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", + "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ReservationDetails": { + "$ref": "./examples/GenerateReservationDetailsReportByBillingAccount.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/enrollmentIdParameter" + }, + { + "$ref": "#/parameters/startDateParameter" + }, + { + "$ref": "#/parameters/endDateParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request processing completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateReservationDetailsReport": { + "post": { + "tags": [ + "ReservedInstances" + ], + "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", + "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ReservationDetails": { + "$ref": "./examples/GenerateReservationDetailsReportByBillingProfile.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "common-types.json#/parameters/billingAccountIdParameter" + }, + { + "$ref": "common-types.json#/parameters/billingProfileIdParameter" + }, + { + "$ref": "#/parameters/startDateParameter" + }, + { + "$ref": "#/parameters/endDateParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request processing completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the Location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ReportConfigDefinition": { + "description": "The definition of a report config.", + "type": "object", + "properties": { + "type": { + "description": "The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.", + "type": "string", + "enum": [ + "Usage" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "WeekToDate", + "MonthToDate", + "YearToDate", + "Custom" + ], + "x-ms-enum": { + "name": "ReportTimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the report.", + "$ref": "#/definitions/ReportConfigTimePeriod" + }, + "dataSet": { + "description": "Has definition for data in this report config.", + "$ref": "#/definitions/ReportConfigDataset" + }, + "includeMonetaryCommitment": { + "description": "If true, report includes monetary commitment.", + "type": "boolean" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "ReportConfigTimePeriod": { + "description": "The start and end date for pulling data for the report.", + "type": "object", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ReportConfigDataset": { + "description": "The definition of data present in the report.", + "type": "object", + "properties": { + "granularity": { + "description": "The granularity of rows in the report.", + "type": "string", + "enum": [ + "Daily", + "Monthly" + ], + "x-ms-enum": { + "name": "ReportGranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/ReportConfigDatasetConfiguration" + }, + "aggregation": { + "type": "object", + "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.", + "additionalProperties": { + "$ref": "#/definitions/ReportConfigAggregation" + }, + "x-ms-identifiers": [ + "name" + ], + "maxItems": 2 + }, + "grouping": { + "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigGrouping" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "maxItems": 2 + }, + "sorting": { + "description": "Array of order by expression to use in the report.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigSorting" + }, + "x-ms-identifiers": [] + }, + "filter": { + "description": "Has filter expression to use in the report.", + "$ref": "#/definitions/ReportConfigFilter" + } + } + }, + "ReportConfigDatasetConfiguration": { + "description": "The configuration of dataset in the report.", + "type": "object", + "properties": { + "columns": { + "description": "Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ReportConfigAggregation": { + "description": "The aggregation expression to be used in the report.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string" + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "ReportConfigSorting": { + "description": "The order by expression to be used in the report.", + "type": "object", + "properties": { + "direction": { + "description": "Direction of sort.", + "type": "string", + "enum": [ + "Ascending", + "Descending" + ], + "x-ms-enum": { + "name": "ReportConfigSortingType", + "modelAsString": true + } + }, + "name": { + "description": "The name of the column to sort.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "ReportConfigGrouping": { + "description": "The group by expression to be used in the report.", + "type": "object", + "properties": { + "type": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/ReportConfigColumnType" + }, + "name": { + "description": "The name of the column to group. This version supports subscription lowest possible grain.", + "type": "string" + } + }, + "required": [ + "type", + "name" + ] + }, + "ReportConfigFilter": { + "description": "The filter expression to be used in the report.", + "type": "object", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "dimensions": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/ReportConfigComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/ReportConfigComparisonExpression" + } + } + }, + "ReportConfigColumnType": { + "description": "The type of the column in the report.", + "type": "string", + "enum": [ + "TagKey", + "Dimension" + ], + "x-ms-enum": { + "name": "QueryColumnType", + "modelAsString": true, + "values": [ + { + "value": "TagKey", + "description": "The tag associated with the cost data." + }, + { + "value": "Dimension", + "description": "The dimension of cost data." + } + ] + } + }, + "ReportConfigComparisonExpression": { + "description": "The comparison expression to be used in the report.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In", + "Contains" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "ViewListResult": { + "description": "Result of listing views. It contains a list of available views.", + "type": "object", + "properties": { + "value": { + "description": "The list of views.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/View" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "View": { + "description": "States and configurations of Cost Analysis.", + "type": "object", + "allOf": [ + { + "$ref": "common-types.json#/definitions/CostManagementProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ViewProperties", + "title": "View properties" + } + } + }, + "ViewProperties": { + "type": "object", + "description": "The properties of the view.", + "properties": { + "displayName": { + "description": "User input name of the view. Required.", + "type": "string" + }, + "scope": { + "description": "Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.", + "type": "string" + }, + "createdOn": { + "description": "Date the user created this view.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "description": "Date when the user last modified this view.", + "type": "string", + "format": "date-time", + "readOnly": false + }, + "dateRange": { + "description": "Date range of the current view.", + "type": "string", + "readOnly": false + }, + "currency": { + "description": "Currency of the current view.", + "type": "string", + "readOnly": true + }, + "query": { + "description": "Query body configuration. Required.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReportConfigDefinition" + }, + "chart": { + "description": "Chart type of the main view in Cost Analysis. Required.", + "type": "string", + "enum": [ + "Area", + "Line", + "StackedColumn", + "GroupedColumn", + "Table" + ], + "x-ms-enum": { + "name": "ChartType", + "modelAsString": true + } + }, + "accumulated": { + "description": "Show costs accumulated over time.", + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "AccumulatedType", + "modelAsString": true + } + }, + "metric": { + "description": "Metric to use when displaying costs.", + "type": "string", + "enum": [ + "ActualCost", + "AmortizedCost", + "AHUB" + ], + "x-ms-enum": { + "name": "MetricType", + "modelAsString": true + } + }, + "kpis": { + "description": "List of KPIs to show in Cost Analysis UI.", + "type": "array", + "items": { + "$ref": "#/definitions/KpiProperties" + } + }, + "pivots": { + "description": "Configuration of 3 sub-views in the Cost Analysis UI.", + "type": "array", + "items": { + "$ref": "#/definitions/PivotProperties" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "KpiProperties": { + "description": "Each KPI must contain a 'type' and 'enabled' key.", + "type": "object", + "properties": { + "type": { + "description": "KPI type (Forecast, Budget).", + "type": "string", + "enum": [ + "Forecast", + "Budget" + ], + "x-ms-enum": { + "name": "KpiTypeType", + "modelAsString": true + } + }, + "id": { + "description": "ID of resource related to metric (budget).", + "type": "string" + }, + "enabled": { + "description": "show the KPI in the UI?", + "type": "boolean" + } + } + }, + "PivotProperties": { + "description": "Each pivot must contain a 'type' and 'name'.", + "type": "object", + "properties": { + "type": { + "description": "Data type to show in view.", + "type": "string", + "enum": [ + "Dimension", + "TagKey" + ], + "x-ms-enum": { + "name": "PivotTypeType", + "modelAsString": true + } + }, + "name": { + "description": "Data field to show in view.", + "type": "string" + } + } + }, + "CostManagementResource": { + "description": "The Resource model definition.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Location of the resource." + }, + "sku": { + "readOnly": true, + "type": "string", + "description": "SKU of the resource." + }, + "eTag": { + "readOnly": true, + "type": "string", + "description": "ETag of the resource." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "DimensionsListResult": { + "description": "Result of listing dimensions. It contains a list of available dimensions.", + "type": "object", + "properties": { + "value": { + "description": "The list of dimensions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Dimension" + } + } + } + }, + "Dimension": { + "description": "List of Dimension.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CostManagementResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DimensionProperties", + "title": "Dimension properties" + } + } + }, + "DimensionProperties": { + "description": "Dimension properties.", + "type": "object", + "properties": { + "description": { + "description": "Dimension description.", + "type": "string", + "readOnly": true + }, + "filterEnabled": { + "description": "Filter enabled.", + "type": "boolean", + "readOnly": true + }, + "groupingEnabled": { + "description": "Grouping enabled.", + "type": "boolean", + "readOnly": true + }, + "data": { + "description": "Dimension data.", + "type": "array", + "items": { + "description": "Dimension data item.", + "type": "string", + "readOnly": true + } + }, + "total": { + "description": "Total number of data for the dimension.", + "format": "int32", + "type": "integer", + "readOnly": true + }, + "category": { + "description": "Dimension category.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "Usage start.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "usageEnd": { + "description": "Usage end.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "AlertsResult": { + "description": "Result of alerts.", + "type": "object", + "properties": { + "value": { + "description": "List of alerts.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "description": "URL to get the next set of alerts results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Alert": { + "description": "An individual alert.", + "type": "object", + "allOf": [ + { + "$ref": "common-types.json#/definitions/CostManagementProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AlertProperties", + "title": "Alert properties" + } + } + }, + "AlertProperties": { + "description": "Alert properties.", + "type": "object", + "properties": { + "definition": { + "description": "defines the type of alert", + "type": "object", + "properties": { + "type": { + "description": "type of alert", + "type": "string", + "enum": [ + "Budget", + "Invoice", + "Credit", + "Quota", + "General", + "xCloud", + "BudgetForecast" + ], + "x-ms-enum": { + "name": "AlertType", + "modelAsString": true + } + }, + "category": { + "description": "Alert category", + "type": "string", + "enum": [ + "Cost", + "Usage", + "Billing", + "System" + ], + "x-ms-enum": { + "name": "AlertCategory", + "modelAsString": true + } + }, + "criteria": { + "description": "Criteria that triggered alert", + "type": "string", + "enum": [ + "CostThresholdExceeded", + "UsageThresholdExceeded", + "CreditThresholdApproaching", + "CreditThresholdReached", + "QuotaThresholdApproaching", + "QuotaThresholdReached", + "MultiCurrency", + "ForecastCostThresholdExceeded", + "ForecastUsageThresholdExceeded", + "InvoiceDueDateApproaching", + "InvoiceDueDateReached", + "CrossCloudNewDataAvailable", + "CrossCloudCollectionError", + "GeneralThresholdError" + ], + "x-ms-enum": { + "name": "AlertCriteria", + "modelAsString": true + } + } + } + }, + "description": { + "description": "Alert description", + "type": "string" + }, + "source": { + "description": "Source of alert", + "type": "string", + "enum": [ + "Preset", + "User" + ], + "x-ms-enum": { + "name": "AlertSource", + "modelAsString": true + } + }, + "details": { + "description": "Alert details", + "type": "object", + "properties": { + "timeGrainType": { + "description": "Type of timegrain cadence", + "type": "string", + "enum": [ + "None", + "Monthly", + "Quarterly", + "Annually", + "BillingMonth", + "BillingQuarter", + "BillingAnnual" + ], + "x-ms-enum": { + "name": "AlertTimeGrainType", + "modelAsString": true + } + }, + "periodStartDate": { + "description": "datetime of periodStartDate", + "type": "string" + }, + "triggeredBy": { + "description": "notificationId that triggered this alert", + "type": "string" + }, + "resourceGroupFilter": { + "description": "array of resourceGroups to filter by", + "type": "array", + "items": {}, + "x-ms-identifiers": [] + }, + "resourceFilter": { + "description": "array of resources to filter by", + "type": "array", + "items": {}, + "x-ms-identifiers": [] + }, + "meterFilter": { + "description": "array of meters to filter by", + "type": "array", + "items": {}, + "x-ms-identifiers": [] + }, + "tagFilter": { + "description": "tags to filter by", + "type": "object", + "properties": {} + }, + "threshold": { + "description": "notification threshold percentage as a decimal which activated this alert", + "type": "number", + "format": "decimal" + }, + "operator": { + "description": "operator used to compare currentSpend with amount", + "type": "string", + "enum": [ + "None", + "EqualTo", + "GreaterThan", + "GreaterThanOrEqualTo", + "LessThan", + "LessThanOrEqualTo" + ], + "x-ms-enum": { + "name": "AlertOperator", + "modelAsString": true + } + }, + "amount": { + "description": "budget threshold amount", + "type": "number", + "format": "decimal" + }, + "unit": { + "description": "unit of currency being used", + "type": "string" + }, + "currentSpend": { + "description": "current spend", + "type": "number", + "format": "decimal" + }, + "contactEmails": { + "description": "list of emails to contact", + "type": "array", + "items": { + "type": "string" + } + }, + "contactGroups": { + "description": "list of action groups to broadcast to", + "type": "array", + "items": { + "type": "string" + } + }, + "contactRoles": { + "description": "list of contact roles", + "type": "array", + "items": { + "type": "string" + } + }, + "overridingAlert": { + "description": "overriding alert", + "type": "string" + }, + "departmentName": { + "description": "department name", + "type": "string" + }, + "companyName": { + "description": "company name", + "type": "string" + }, + "enrollmentNumber": { + "description": "enrollment number", + "type": "string" + }, + "enrollmentStartDate": { + "description": "datetime of enrollmentStartDate", + "type": "string" + }, + "enrollmentEndDate": { + "description": "datetime of enrollmentEndDate", + "type": "string" + }, + "invoicingThreshold": { + "description": "invoicing threshold", + "type": "number", + "format": "decimal" + } + } + }, + "costEntityId": { + "description": "related budget", + "type": "string" + }, + "status": { + "description": "alert status", + "type": "string", + "enum": [ + "None", + "Active", + "Overridden", + "Resolved", + "Dismissed" + ], + "x-ms-enum": { + "name": "AlertStatus", + "modelAsString": true + } + }, + "creationTime": { + "description": "dateTime in which alert was created", + "type": "string" + }, + "closeTime": { + "description": "dateTime in which alert was closed", + "type": "string" + }, + "modificationTime": { + "description": "dateTime in which alert was last modified", + "type": "string" + }, + "statusModificationUserName": { + "description": "User who last modified the alert", + "type": "string" + }, + "statusModificationTime": { + "description": "dateTime in which the alert status was last modified", + "type": "string" + } + } + }, + "DismissAlertPayload": { + "description": "The request payload to update an alert", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AlertProperties", + "title": "Alert properties" + } + } + }, + "ForecastResult": { + "description": "Result of forecast. It contains all columns listed under groupings and aggregation.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CostManagementResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ForecastProperties", + "title": "Forecast properties" + } + } + }, + "ForecastProperties": { + "description": "Forecast properties", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string" + }, + "columns": { + "description": "Array of columns", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastColumn" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "rows": { + "description": "Array of rows", + "type": "array", + "items": { + "type": "array", + "items": {}, + "x-ms-identifiers": [] + }, + "x-ms-identifiers": [] + } + } + }, + "ForecastColumn": { + "description": "Forecast column properties", + "type": "object", + "properties": { + "name": { + "description": "The name of column.", + "type": "string" + }, + "type": { + "description": "The type of column.", + "type": "string" + } + } + }, + "QueryResult": { + "description": "Result of query. It contains all columns listed under groupings and aggregation.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CostManagementResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/QueryProperties", + "title": "Query properties" + } + } + }, + "QueryProperties": { + "description": "Query properties", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string" + }, + "columns": { + "description": "Array of columns", + "type": "array", + "items": { + "$ref": "#/definitions/QueryColumn" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "rows": { + "description": "Array of rows", + "type": "array", + "items": { + "type": "array", + "items": {}, + "x-ms-identifiers": [] + }, + "x-ms-identifiers": [] + } + } + }, + "QueryColumn": { + "description": "QueryColumn properties", + "type": "object", + "properties": { + "name": { + "description": "The name of column.", + "type": "string" + }, + "type": { + "description": "The type of column.", + "type": "string" + } + } + }, + "ForecastDefinition": { + "description": "The definition of a forecast.", + "type": "object", + "properties": { + "type": { + "description": "The type of the forecast.", + "$ref": "#/definitions/ForecastType" + }, + "timeframe": { + "description": "The time frame for pulling data for the forecast. If custom, then a specific time period must be provided.", + "$ref": "#/definitions/ForecastTimeframe" + }, + "timePeriod": { + "description": "Has time period for pulling data for the forecast.", + "$ref": "#/definitions/ForecastTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this forecast.", + "$ref": "#/definitions/ForecastDataset" + }, + "includeActualCost": { + "description": "A boolean determining if actualCost will be included.", + "type": "boolean" + }, + "includeFreshPartialCost": { + "description": "A boolean determining if FreshPartialCost will be included.", + "type": "boolean" + } + }, + "required": [ + "type", + "timeframe", + "dataset" + ] + }, + "ForecastType": { + "description": "The type of the forecast.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ForecastType", + "modelAsString": true + } + }, + "ForecastTimeframe": { + "description": "The time frame for pulling data for the forecast.", + "type": "string", + "enum": [ + "Custom" + ], + "x-ms-enum": { + "name": "ForecastTimeframe", + "modelAsString": true + } + }, + "ForecastTimePeriod": { + "description": "Has time period for pulling data for the forecast.", + "type": "object", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ForecastDataset": { + "description": "The definition of data present in the forecast.", + "type": "object", + "properties": { + "granularity": { + "description": "The granularity of rows in the forecast.", + "$ref": "#/definitions/GranularityType" + }, + "configuration": { + "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/ForecastDatasetConfiguration" + }, + "aggregation": { + "description": "Dictionary of aggregation expression to use in the forecast. The key of each item in the dictionary is the alias for the aggregated column. forecast can have up to 2 aggregation clauses.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ForecastAggregation" + }, + "maxItems": 2 + }, + "filter": { + "description": "Has filter expression to use in the forecast.", + "$ref": "#/definitions/ForecastFilter" + } + }, + "required": [ + "aggregation" + ] + }, + "GranularityType": { + "description": "The granularity of rows in the forecast.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "ForecastDatasetConfiguration": { + "description": "The configuration of dataset in the forecast.", + "type": "object", + "properties": { + "columns": { + "description": "Array of column names to be included in the forecast. Any valid forecast column name is allowed. If not provided, then forecast includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ForecastAggregation": { + "description": "The aggregation expression to be used in the forecast.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string", + "enum": [ + "PreTaxCostUSD", + "Cost", + "CostUSD", + "PreTaxCost" + ], + "x-ms-enum": { + "name": "FunctionName", + "modelAsString": true + } + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "ForecastFilter": { + "description": "The filter expression to be used in the export.", + "type": "object", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "dimensions": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/ForecastComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/ForecastComparisonExpression" + } + } + }, + "ForecastComparisonExpression": { + "description": "The comparison expression to be used in the forecast.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "ForecastOperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "QueryDefinition": { + "description": "The definition of a query.", + "type": "object", + "properties": { + "type": { + "description": "The type of the query.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ExportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the query. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "MonthToDate", + "BillingMonthToDate", + "TheLastMonth", + "TheLastBillingMonth", + "WeekToDate", + "Custom" + ], + "x-ms-enum": { + "name": "TimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the query.", + "$ref": "#/definitions/QueryTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this query.", + "$ref": "#/definitions/QueryDataset" + } + }, + "required": [ + "type", + "timeframe", + "dataset" + ] + }, + "QueryTimePeriod": { + "description": "The start and end date for pulling data for the query.", + "type": "object", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "QueryDataset": { + "description": "The definition of data present in the query.", + "type": "object", + "properties": { + "granularity": { + "description": "The granularity of rows in the query.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/QueryDatasetConfiguration" + }, + "aggregation": { + "type": "object", + "description": "Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses.", + "additionalProperties": { + "$ref": "#/definitions/QueryAggregation" + }, + "maxItems": 2 + }, + "grouping": { + "description": "Array of group by expression to use in the query. Query can have up to 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryGrouping" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "maxItems": 2 + }, + "filter": { + "description": "The filter expression to use in the query. Please reference our Query API REST documentation for how to properly format the filter.", + "$ref": "#/definitions/QueryFilter" + } + } + }, + "OperationStatus": { + "description": "The status of the long running operation.", + "type": "object", + "properties": { + "status": { + "description": "The status of the long running operation.", + "type": "string", + "enum": [ + "Running", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "OperationStatusType", + "modelAsString": true + } + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the resource generated.", + "$ref": "#/definitions/ReportURL" + } + } + }, + "ReportURL": { + "description": "The URL to download the generated report.", + "type": "object", + "properties": { + "reportUrl": { + "description": "The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity", + "$ref": "#/definitions/ReservationReportSchema" + }, + "validUntil": { + "description": "The time at which report URL becomes invalid.", + "type": "string", + "format": "date-time" + } + } + }, + "QueryDatasetConfiguration": { + "description": "The configuration of dataset in the query.", + "type": "object", + "properties": { + "columns": { + "description": "Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "QueryAggregation": { + "description": "The aggregation expression to be used in the query.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string" + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "QueryGrouping": { + "description": "The group by expression to be used in the query.", + "type": "object", + "properties": { + "type": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/QueryColumnType" + }, + "name": { + "description": "The name of the column to group.", + "type": "string" + } + }, + "required": [ + "type", + "name" + ] + }, + "QueryFilter": { + "description": "The filter expression to be used in the export.", + "type": "object", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "dimensions": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/QueryComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/QueryComparisonExpression" + } + } + }, + "QueryColumnType": { + "description": "The type of the column in the export.", + "type": "string", + "enum": [ + "TagKey", + "Dimension" + ], + "x-ms-enum": { + "name": "QueryColumnType", + "modelAsString": true, + "values": [ + { + "value": "TagKey", + "description": "The tag associated with the cost data." + }, + { + "value": "Dimension", + "description": "The dimension of cost data." + } + ] + } + }, + "QueryComparisonExpression": { + "description": "The comparison expression to be used in the query.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "QueryOperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "ReservationReportSchema": { + "description": "The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity", + "type": "string", + "enum": [ + "InstanceFlexibilityGroup", + "InstanceFlexibilityRatio", + "InstanceId", + "Kind", + "ReservationId", + "ReservationOrderId", + "ReservedHours", + "SkuName", + "TotalReservedQuantity", + "UsageDate", + "UsedHours" + ], + "x-ms-enum": { + "name": "ReservationReportSchema", + "modelAsString": true + } + } + }, + "parameters": { + "viewNameParameter": { + "name": "viewName", + "in": "path", + "description": "View name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "scopeViewParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope.", + "x-ms-parameter-location": "method" + }, + "scopeDimensionParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with dimension operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeAlertParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeForecastParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with forecast operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeQueryParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with query and export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure Resource Group Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "startDateParameter": { + "name": "startDate", + "in": "query", + "description": "Start Date", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "endDateParameter": { + "name": "endDate", + "in": "query", + "description": "End Date", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "Enrollment ID (Legacy BillingAccount ID)", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "managementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "description": "ManagementGroup ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "departmentIdParameter": { + "name": "departmentId", + "in": "path", + "description": "Department ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountIdParameter": { + "name": "enrollmentAccountId", + "in": "path", + "description": "Enrollment Account ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "externalCloudProviderTypeParameter": { + "name": "externalCloudProviderType", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "externalSubscriptions", + "externalBillingAccounts" + ], + "x-ms-enum": { + "name": "externalCloudProviderType", + "modelAsString": true + }, + "description": "The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.", + "x-ms-parameter-location": "method" + }, + "externalCloudProviderIdParameter": { + "name": "externalCloudProviderId", + "in": "path", + "required": true, + "type": "string", + "description": "This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.", + "x-ms-parameter-location": "method" + }, + "alertIdParameter": { + "name": "alertId", + "in": "path", + "description": "Alert ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json new file mode 100644 index 000000000000..b54413eaf3d3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json @@ -0,0 +1,189 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01", + "title": "CostManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/providers/Microsoft.CostManagement/pricesheets/default/download": { + "post": { + "tags": [ + "PriceSheets" + ], + "x-ms-examples": { + "PricesheetDownload": { + "$ref": "./examples/PricesheetDownload.json" + } + }, + "operationId": "PriceSheet_Download", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download the pricesheet for an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + }, + "OData-EntityId": { + "description": "The operation entity Id GUID.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "common-types.json#/definitions/DownloadURL" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.CostManagement/pricesheets/default/download": { + "post": { + "tags": [ + "PriceSheets" + ], + "x-ms-examples": { + "PricesheetDownloadByBillingProfile": { + "$ref": "./examples/PricesheetDownloadByBillingProfile.json" + } + }, + "operationId": "PriceSheet_DownloadByBillingProfile", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download the current month's pricesheet for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single csv file to a Zip file containing multiple csv files, each with max 200k records.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + }, + "OData-EntityId": { + "description": "The operation entity Id GUID.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "common-types.json#/definitions/DownloadURL" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "parameters": { + "billingAccountNameParameter": { + "name": "billingAccountName", + "in": "path", + "description": "The ID that uniquely identifies a billing account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+):([A-Za-z0-9]+(-[A-Za-z0-9]+)+)_[0-9]{4}-[0-9]{2}-[0-9]{2}" + }, + "billingProfileNameParameter": { + "name": "billingProfileName", + "in": "path", + "description": "The ID that uniquely identifies a billing profile.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+)" + }, + "invoiceNameParameter": { + "name": "invoiceName", + "in": "path", + "description": "The ID that uniquely identifies an invoice.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "[A-Za-z0-9]+" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitRecommendationsByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitRecommendationsByBillingAccount.json new file mode 100644 index 000000000000..b6a3327d4742 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitRecommendationsByBillingAccount.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingScope": "providers/Microsoft.Billing/billingAccounts/123456", + "$expand": "properties/usage,properties/allRecommendationDetails", + "$filter": "properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/benefitRecommendations", + "kind": "SavingsPlan", + "properties": { + "firstConsumptionDate": "2022-10-18T00:00:00Z", + "lastConsumptionDate": "2022-10-25T00:00:00Z", + "lookBackPeriod": "Last7Days", + "totalHours": 168, + "usage": { + "usageGrain": "Hourly", + "charges": [ + 1.0, + 1.0, + 0.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 2.0, + 2.0, + 2.0, + 2.0 + ] + }, + "armSkuName": "Compute_Savings_Plan", + "term": "P1Y", + "commitmentGranularity": "Hourly", + "currencyCode": "USD", + "costWithoutBenefit": 218.267, + "scope": "Shared", + "recommendationDetails": { + "averageUtilizationPercentage": 99.330, + "coveragePercentage": 54.609, + "commitmentAmount": 0.164, + "overageCost": 144.841, + "benefitCost": 52.002, + "savingsAmount": 21.424, + "savingsPercentage": 9.815, + "totalCost": 196.843, + "wastageCost": 0.035 + }, + "allRecommendationDetails": { + "value": [ + { + "averageUtilizationPercentage": 99.330, + "coveragePercentage": 54.609, + "commitmentAmount": 0.164, + "overageCost": 144.841, + "benefitCost": 52.002, + "savingsAmount": 21.424, + "savingsPercentage": 9.815, + "totalCost": 196.843, + "wastageCost": 0.035 + }, + { + "averageUtilizationPercentage": 81.474, + "coveragePercentage": 56.748, + "commitmentAmount": 0.161, + "overageCost": 120.389, + "benefitCost": 83.754, + "savingsAmount": 14.124, + "savingsPercentage": 6.470, + "totalCost": 204.143, + "wastageCost": 0.100 + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json new file mode 100644 index 000000000000..408656649ecb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingAccount.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "8099099", + "benefitUtilizationSummariesRequest": { + "kind": "Reservation", + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z", + "grain": "Daily" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/8099099/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "input": { + "grain": "Daily", + "billingAccountId": "8099099", + "kind": "Reservation", + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z" + }, + "status": "Complete", + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json new file mode 100644 index 000000000000..14410cc9922a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByBillingProfile.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "00000000-0000-0000-0000-000000000000", + "billingProfileId": "CZSFR-SDFXC-DSDF", + "benefitUtilizationSummariesRequest": { + "kind": "Reservation", + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z", + "grain": "Daily" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "input": { + "grain": "Daily", + "billingAccountId": "00000000-0000-0000-0000-000000000000", + "billingProfileId": "CZSFR-SDFXC-DSDF", + "kind": "Reservation", + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z" + }, + "status": "Complete", + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json new file mode 100644 index 000000000000..b367a57b8e99 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservation.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "reservationId": "00000000-0000-0000-0000-000000000000", + "benefitUtilizationSummariesRequest": { + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z", + "grain": "Daily" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/reservations/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "input": { + "grain": "Daily", + "benefitOrderId": "00000000-0000-0000-0000-000000000000", + "benefitId": "00000000-0000-0000-0000-000000000000", + "kind": "Reservation", + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z" + }, + "status": "Complete", + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json new file mode 100644 index 000000000000..25d709b05ee9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportByReservationOrder.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "reservationOrderId": "00000000-0000-0000-0000-000000000000", + "benefitUtilizationSummariesRequest": { + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z", + "grain": "Daily" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Capacity/reservationorders/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "input": { + "grain": "Daily", + "benefitOrderId": "00000000-0000-0000-0000-000000000000", + "kind": "Reservation", + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z" + }, + "status": "Complete", + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json new file mode 100644 index 000000000000..0be67ff69b5f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlan.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "savingsPlanOrderId": "00000000-0000-0000-0000-000000000000", + "savingsPlanId": "00000000-0000-0000-0000-000000000000", + "benefitUtilizationSummariesRequest": { + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z", + "grain": "Daily" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "input": { + "grain": "Daily", + "benefitOrderId": "00000000-0000-0000-0000-000000000000", + "benefitId": "00000000-0000-0000-0000-000000000000", + "kind": "SavingsPlan", + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z" + }, + "status": "Complete", + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json new file mode 100644 index 000000000000..99238c32e87f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/Async/GenerateBenefitUtilizationSummariesReportBySavingsPlanOrder.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "savingsPlanOrderId": "00000000-0000-0000-0000-000000000000", + "benefitUtilizationSummariesRequest": { + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z", + "grain": "Daily" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "input": { + "grain": "Daily", + "benefitOrderId": "00000000-0000-0000-0000-000000000000", + "kind": "SavingsPlan", + "endDate": "2022-08-31T00:00:00Z", + "startDate": "2022-06-01T00:00:00Z" + }, + "status": "Complete", + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2022-06-12T02:56:55.5021869Z" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json new file mode 100644 index 000000000000..e33c951e99fb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Daily" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/benefitUtilizationSummaries/88cccc88-8ccc-8c88-888c-88cc8c8c88c8_444d44dd-d4d4-4dd4-444d-4dd4444ddddd_20211117", + "kind": "SavingsPlan", + "name": "88cccc88-8ccc-8c88-888c-88cc8c8c88c8_444d44dd-d4d4-4dd4-444d-4dd4444ddddd_20211117", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 60, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/88cccc88-8ccc-8c88-888c-88cc8c8c88c8", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/88cccc88-8ccc-8c88-888c-88cc8c8c88c8/savingsPlans/444d44dd-d4d4-4dd4-444d-4dd4444ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 70, + "minUtilizationPercentage": 50, + "usageDate": "2022-10-17T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json new file mode 100644 index 000000000000..5cfcd7b18289 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "c0a00000-0e04-5ee3-000e-f0c6e00000ec:c0a00000-0e04-5ee3-000e-f0c6e00000ec", + "billingProfileId": "200e5e90-000e-4960-8dcd-8d00a02db000", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Daily" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/c0a00000-0e04-5ee3-000e-f0c6e00000ec:c0a00000-0e04-5ee3-000e-f0c6e00000ec/billingProfiles/200e5e90-000e-4960-8dcd-8d00a02db000/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json new file mode 100644 index 000000000000..344fa50f8bce --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "savingsPlanOrderId": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "savingsPlanId": "222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Monthly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202111", + "kind": "SavingsPlan", + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202111", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + }, + { + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202112", + "kind": "SavingsPlan", + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202112", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 80, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 90, + "minUtilizationPercentage": 70, + "usageDate": "2022-10-17T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json new file mode 100644 index 000000000000..a7fb545c2798 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "savingsPlanOrderId": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Daily" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountAlerts.json new file mode 100644 index 000000000000..3c0da3e2012d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountDimensionsList.json new file mode 100644 index 000000000000..b4f1892608ff --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountDimensionsList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..4d5315ac7f48 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..d89ce74aff8f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountDimensionsListWithFilter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountForecast.json new file mode 100644 index 000000000000..2bbc4ada87be --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountForecast.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountQuery.json new file mode 100644 index 000000000000..eebf140e5438 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "70664866", + "scope": "providers/Microsoft.Billing/billingAccounts/70664866", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountQueryGrouping.json new file mode 100644 index 000000000000..1276b44f2053 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingAccountQueryGrouping.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "70664866", + "scope": "providers/Microsoft.Billing/billingAccounts/70664866", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingProfileAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingProfileAlerts.json new file mode 100644 index 000000000000..90bc097b647a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingProfileAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingProfileForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingProfileForecast.json new file mode 100644 index 000000000000..cd23f794d7db --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/BillingProfileForecast.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json new file mode 100644 index 000000000000..7049d4c76eb6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json new file mode 100644 index 000000000000..35f0f6b429ac --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json new file mode 100644 index 000000000000..e838af2588c9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json new file mode 100644 index 000000000000..468392fa8718 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json new file mode 100644 index 000000000000..d5e538b06eaf --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json new file mode 100644 index 000000000000..68ba6955aa14 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json new file mode 100644 index 000000000000..96b508c29d59 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json new file mode 100644 index 000000000000..b8a902859994 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json new file mode 100644 index 000000000000..fe21990bc2e0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json new file mode 100644 index 000000000000..e96b16e41f40 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/Delete/DeleteBudget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/Delete/DeleteBudget.json new file mode 100644 index 000000000000..0d54a6b09860 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/Delete/DeleteBudget.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/Get/Cost/Get-Cost-Budget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/Get/Cost/Get-Cost-Budget.json new file mode 100644 index 000000000000..70bb1e9fcd17 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/Get/Cost/Get-Cost-Budget.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json new file mode 100644 index 000000000000..a8c6544f94f6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json new file mode 100644 index 000000000000..b1e910b213fc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "$filter": "properties/category eq 'ReservationUtilization'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json new file mode 100644 index 000000000000..227f38279f69 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "properties": { + "category": "Cost", + "amount": 10000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 8000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestBudget2", + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "properties": { + "category": "Cost", + "amount": 15000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 12000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/DepartmentBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/DepartmentBudgetsList.json new file mode 100644 index 000000000000..44a3faa72af9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/DepartmentBudgetsList.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "departmentId": "789101", + "scope": "providers/Microsoft.Billing/billingAccounts/123456/departments/789101" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/departments/789101/providers/Microsoft.CostManagement/budgets/DepartmentBudget1", + "name": "DepartmentBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157e\"", + "properties": { + "category": "Cost", + "amount": 5000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 3000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/departments/789101/providers/Microsoft.CostManagement/budgets/DepartmentBudget2", + "name": "DepartmentBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 8000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 6000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_75_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 75, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json new file mode 100644 index 000000000000..79326b2cee17 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "enrollmentAccountId": "473845", + "scope": "providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845/providers/Microsoft.CostManagement/budgets/EnrollmentAccountBudget1", + "name": "EnrollmentAccountBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157e\"", + "properties": { + "category": "Cost", + "amount": 5000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 3000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845/providers/Microsoft.CostManagement/budgets/EnrollmentAccountBudget2", + "name": "EnrollmentAccountBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 8000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 6000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_75_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 75, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json new file mode 100644 index 000000000000..cd2302de6a0f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "$filter": "properties/category eq 'ReservationUtilization'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json new file mode 100644 index 000000000000..fe0be22adf2d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "properties": { + "category": "Cost", + "amount": 10000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 8000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/providers/Microsoft.CostManagement/budgets/TestBudget2", + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "properties": { + "category": "Cost", + "amount": 15000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 12000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json new file mode 100644 index 000000000000..b39d86a3338d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "MYDEVTESTBP", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP", + "$filter": "properties/category eq 'ReservationUtilization'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 80, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingProfileBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingProfileBudgetsList.json new file mode 100644 index 000000000000..eb0175830532 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/BillingProfileBudgetsList.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "MYDEVTESTBP", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "properties": { + "category": "Cost", + "amount": 200.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 30.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestBudget2", + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "properties": { + "category": "Cost", + "amount": 600.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 20.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 80, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json new file mode 100644 index 000000000000..7dec877b20e5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "$filter": "properties/category eq 'ReservationUtilization'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 80, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/CustomerBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/CustomerBudgetsList.json new file mode 100644 index 000000000000..bdd0419ca3b6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/CustomerBudgetsList.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "properties": { + "category": "Cost", + "amount": 200.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 30.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestBudget2", + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "properties": { + "category": "Cost", + "amount": 600.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 20.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 80, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json new file mode 100644 index 000000000000..e812bf57d94e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "MYDEVTESTBP", + "invoiceSectionId": "AAAA-BBBB-CCC-DDD", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "properties": { + "category": "Cost", + "amount": 20.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 5.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD/providers/Microsoft.CostManagement/budgets/TestBudget2", + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "properties": { + "category": "Cost", + "amount": 60.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 20.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json new file mode 100644 index 000000000000..1925815af52b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "MYDEVTESTMG", + "scope": "Microsoft.Management/managementGroups/MYDEVTESTMG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "Microsoft.Management/managementGroups/MYDEVTESTMG/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 10000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 8000.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "managers@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 600.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_90_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 200.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_40_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 40, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json new file mode 100644 index 000000000000..d0cd6ea09d68 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "resourceGroupName": "MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget0", + "name": "TestBudget0", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_90_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 200.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_40_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 40, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json new file mode 100644 index 000000000000..646e60b21b6c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 600.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_90_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 200.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_40_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 40, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleCheckNameAvailability.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleCheckNameAvailability.json new file mode 100644 index 000000000000..6758e731f5ec --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleCheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "costAllocationRuleCheckNameAvailabilityRequest": { + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "A cost allocation rule with name testRule is already present for the billing account 100. Please specify a differnt name." + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleCreate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleCreate.json new file mode 100644 index 000000000000..ebff07eb6dd1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleCreate.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "ruleName": "testRule", + "costAllocationRule": { + "properties": { + "description": "This is a testRule", + "status": "Active", + "details": { + "sourceResources": [ + { + "resourceType": "Dimension", + "name": "ResourceGroupName", + "values": [ + "sampleRG", + "secondRG" + ] + } + ], + "targetResources": [ + { + "resourceType": "Dimension", + "policyType": "FixedProportion", + "name": "ResourceGroupName", + "values": [ + { + "name": "destinationRG", + "percentage": 45 + }, + { + "name": "destinationRG2", + "percentage": 54 + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "status": "Creating", + "details": { + "sourceResources": [ + { + "resourceType": "Dimension", + "name": "ResourceGroupName", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "resourceType": "Dimension", + "policyType": "FixedProportion", + "name": "ResourceGroupName", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "status": "Creating", + "details": { + "sourceResources": [ + { + "resourceType": "Dimension", + "name": "ResourceGroupName", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "resourceType": "Dimension", + "policyType": "FixedProportion", + "name": "ResourceGroupName", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleCreateTag.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleCreateTag.json new file mode 100644 index 000000000000..25a32f79c5d2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleCreateTag.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "ruleName": "testRule", + "costAllocationRule": { + "properties": { + "description": "This is a testRule", + "status": "Active", + "details": { + "sourceResources": [ + { + "resourceType": "Tag", + "name": "category", + "values": [ + "devops" + ] + } + ], + "targetResources": [ + { + "resourceType": "Dimension", + "policyType": "FixedProportion", + "name": "ResourceGroupName", + "values": [ + { + "name": "destinationRG", + "percentage": 33.33 + }, + { + "name": "destinationRG2", + "percentage": 33.33 + }, + { + "name": "destinationRG3", + "percentage": 33.34 + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "status": "Creating", + "details": { + "sourceResources": [ + { + "resourceType": "Dimension", + "name": "ResourceGroupName", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "resourceType": "Dimension", + "policyType": "FixedProportion", + "name": "ResourceGroupName", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "status": "Creating", + "details": { + "sourceResources": [ + { + "resourceType": "Dimension", + "name": "ResourceGroupName", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "resourceType": "Dimension", + "policyType": "FixedProportion", + "name": "ResourceGroupName", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleDelete.json new file mode 100644 index 000000000000..625e66d9dca4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleDelete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "ruleName": "testRule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleGet.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleGet.json new file mode 100644 index 000000000000..851d2ccfd72b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRuleGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "ruleName": "testRule" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "status": "NotActive", + "details": { + "sourceResources": [ + { + "resourceType": "Dimension", + "name": "ResourceGroupName", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "resourceType": "Dimension", + "policyType": "FixedProportion", + "name": "ResourceGroupName", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRulesList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRulesList.json new file mode 100644 index 000000000000..ef4492bb579e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostAllocationRulesList.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule", + "name": "testRule", + "type": "Microsoft.CostManagement/costAllocationRules", + "properties": { + "description": "This is a testRule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "status": "NotActive", + "details": { + "sourceResources": [ + { + "resourceType": "Dimension", + "name": "ResourceGroupName", + "values": [ + "sampleRG" + ] + } + ], + "targetResources": [ + { + "resourceType": "Dimension", + "policyType": "FixedProportion", + "name": "ResourceGroupName", + "values": [ + { + "name": "destinationRG", + "percentage": 50 + }, + { + "name": "destinationRG2", + "percentage": 50 + } + ] + } + ] + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule2", + "name": "testRule2", + "type": "Microsoft.CostManagement/costAllocationRules", + "properties": { + "description": "This is a second test Rule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "status": "Active", + "details": { + "sourceResources": [ + { + "resourceType": "Dimension", + "name": "SubscriptionId", + "values": [ + "2A002F2D-536F-4D7C-90DA-3D0BAE879B0E" + ] + } + ], + "targetResources": [ + { + "resourceType": "Tag", + "policyType": "FixedProportion", + "name": "category", + "values": [ + { + "name": "devops", + "percentage": 100 + } + ] + } + ] + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/costAllocationRules/testRule3", + "name": "testRule3", + "type": "Microsoft.CostManagement/costAllocationRules", + "properties": { + "description": "This is a third test Rule", + "createdDate": "2020-06-18T22:21:51.1287144Z", + "updatedDate": "2020-06-18T22:21:51.1287144Z", + "status": "Active", + "details": { + "sourceResources": [ + { + "resourceType": "Tag", + "name": "category", + "values": [ + "devops" + ] + } + ], + "targetResources": [ + { + "resourceType": "Dimension", + "policyType": "FixedProportion", + "name": "ResourceGroupName", + "values": [ + { + "name": "ResourceGroup", + "percentage": 55.55 + }, + { + "name": "ResourceGroupSecond", + "percentage": 44.45 + } + ] + } + ] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostDetailsOperationResultsBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostDetailsOperationResultsBySubscriptionScope.json new file mode 100644 index 000000000000..93b9782fe693 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/CostDetailsOperationResultsBySubscriptionScope.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "operationId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-11-01", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000", + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentAlerts.json new file mode 100644 index 000000000000..c3c7fc8902d1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentDimensionsList.json new file mode 100644 index 000000000000..e987034ed687 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentDimensionsList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..44876c9cace4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentDimensionsListExpandAndTop.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "departmentId": "123", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentDimensionsListWithFilter.json new file mode 100644 index 000000000000..a3a96aa5faa1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentDimensionsListWithFilter.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "departmentId": "123", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentForecast.json new file mode 100644 index 000000000000..b5b9e5a75cff --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentForecast.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentQuery.json new file mode 100644 index 000000000000..9632d3db738f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "70664866", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentQueryGrouping.json new file mode 100644 index 000000000000..2a92772c5b84 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DepartmentQueryGrouping.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "70664866", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DismissResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DismissResourceGroupAlerts.json new file mode 100644 index 000000000000..afc62101cd2c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DismissResourceGroupAlerts.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "alertId": "22222222-2222-2222-2222-222222222222", + "parameters": { + "properties": { + "status": "Dismissed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Dismissed", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DismissSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DismissSubscriptionAlerts.json new file mode 100644 index 000000000000..cce9a263c749 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/DismissSubscriptionAlerts.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "alertId": "22222222-2222-2222-2222-222222222222", + "parameters": { + "properties": { + "status": "Dismissed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Dismissed", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountAlerts.json new file mode 100644 index 000000000000..0474ab719049 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountDimensionsList.json new file mode 100644 index 000000000000..7b86371cb9e2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountDimensionsList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..f915f7f3b4f5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..68a7f7cc202c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountDimensionsListWithFilter.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountForecast.json new file mode 100644 index 000000000000..83b3d8346bf1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountForecast.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountQuery.json new file mode 100644 index 000000000000..e2aad5d9f121 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountQueryGrouping.json new file mode 100644 index 000000000000..1f52d059ee7d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/EnrollmentAccountQueryGrouping.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByBillingAccount.json new file mode 100644 index 000000000000..d4cd1c1b6e12 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByBillingAccount.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByDepartment.json new file mode 100644 index 000000000000..c0f835085bba --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByDepartment.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json new file mode 100644 index 000000000000..a461575b0b0b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByManagementGroup.json new file mode 100644 index 000000000000..ddbd1fd3798c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByManagementGroup.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByResourceGroup.json new file mode 100644 index 000000000000..9846ba2cc084 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateByResourceGroup.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateBySubscription.json new file mode 100644 index 000000000000..9539c82eb247 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportCreateOrUpdateBySubscription.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByBillingAccount.json new file mode 100644 index 000000000000..123385d32e9d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByBillingAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByDepartment.json new file mode 100644 index 000000000000..b97ea1e36a52 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByDepartment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByEnrollmentAccount.json new file mode 100644 index 000000000000..64de2ec4380a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByEnrollmentAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByManagementGroup.json new file mode 100644 index 000000000000..100ee2098c43 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByManagementGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByResourceGroup.json new file mode 100644 index 000000000000..b3e5d63f63ff --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteByResourceGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteBySubscription.json new file mode 100644 index 000000000000..3b8ffd95b484 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportDeleteBySubscription.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByBillingAccount.json new file mode 100644 index 000000000000..f74c45eda79d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByBillingAccount.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-05-01T00:00:00Z", + "to": "2020-05-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByDepartment.json new file mode 100644 index 000000000000..65ff5b2fca30 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByDepartment.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByEnrollmentAccount.json new file mode 100644 index 000000000000..6ff7130f5276 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByEnrollmentAccount.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2019-09-01T00:00:00Z", + "to": "2019-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByManagementGroup.json new file mode 100644 index 000000000000..a421636fc1f3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByManagementGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2019-09-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "UsageDate", + "MeterId", + "InstanceId", + "ResourceLocation", + "UsageQuantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByResourceGroup.json new file mode 100644 index 000000000000..1a29fe264c18 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetBySubscription.json new file mode 100644 index 000000000000..50e9fca5c5bd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportGetBySubscription.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2019-06-01T00:00:00Z", + "to": "2019-07-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByBillingAccount.json new file mode 100644 index 000000000000..123385d32e9d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByBillingAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByDepartment.json new file mode 100644 index 000000000000..b97ea1e36a52 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByDepartment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByEnrollmentAccount.json new file mode 100644 index 000000000000..64de2ec4380a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByEnrollmentAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByManagementGroup.json new file mode 100644 index 000000000000..100ee2098c43 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByManagementGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByResourceGroup.json new file mode 100644 index 000000000000..b3e5d63f63ff --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunByResourceGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunBySubscription.json new file mode 100644 index 000000000000..3b8ffd95b484 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunBySubscription.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByBillingAccount.json new file mode 100644 index 000000000000..49aaecace287 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByBillingAccount.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByDepartment.json new file mode 100644 index 000000000000..f6e10277ab4b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByDepartment.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByEnrollmentAccount.json new file mode 100644 index 000000000000..5e3a4493d86c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByEnrollmentAccount.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByManagementGroup.json new file mode 100644 index 000000000000..b02059d33a8d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByManagementGroup.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByResourceGroup.json new file mode 100644 index 000000000000..839592396719 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetByResourceGroup.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetBySubscription.json new file mode 100644 index 000000000000..4a2c1db0daa6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportRunHistoryGetBySubscription.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByBillingAccount.json new file mode 100644 index 000000000000..2892a2f76217 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByBillingAccount.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByDepartment.json new file mode 100644 index 000000000000..489982da9d17 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByDepartment.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByEnrollmentAccount.json new file mode 100644 index 000000000000..729052733ed7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByEnrollmentAccount.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByManagementGroup.json new file mode 100644 index 000000000000..40ff47da3205 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByManagementGroup.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByResourceGroup.json new file mode 100644 index 000000000000..c12a24da0f2d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetByResourceGroup.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetBySubscription.json new file mode 100644 index 000000000000..72f1b5faf13e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExportsGetBySubscription.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "centralus", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountAlerts.json new file mode 100644 index 000000000000..94aa8d7f0a84 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountForecast.json new file mode 100644 index 000000000000..9b39a1fa11d5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountForecast.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 0.0, + "Forecast", + "USD" + ], + [ + 30.2572751438, + "Forecast", + "USD" + ], + [ + 0.076757602000000022, + "Forecast", + "USD" + ], + [ + 50.430964190400012, + "Forecast", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountsDimensions.json new file mode 100644 index 000000000000..a2a5d08505e9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountsDimensions.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceType_2019-12-01_2019-12-31", + "name": "dimensions_ResourceType_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 0, + "category": "ResourceType", + "description": "Resource type", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceId_2019-12-01_2019-12-31", + "name": "dimensions_ResourceId_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 0, + "category": "ResourceId", + "description": "Resource ID", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountsQuery.json new file mode 100644 index 000000000000..0f28f702379e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalBillingAccountsQuery.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ServiceName", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 0.0, + "abc db", + "USD" + ], + [ + 30.2572751438, + "abc compute cloud", + "USD" + ], + [ + 0.076757602000000022, + "abc file system", + "USD" + ], + [ + 50.430964190400012, + "abc elasticache", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionAlerts.json new file mode 100644 index 000000000000..70e1a4255214 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionForecast.json new file mode 100644 index 000000000000..a6a2f913de62 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionForecast.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", + "name": "d99477af-7510-40ee-aca2-e59bdca0d10d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionsDimensions.json new file mode 100644 index 000000000000..6e197494b63e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionsDimensions.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceType_2019-12-01_2019-12-31", + "name": "dimensions_ResourceType_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 0, + "category": "ResourceType", + "description": "Resource type", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceId_2019-12-01_2019-12-31", + "name": "dimensions_ResourceId_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 0, + "category": "ResourceId", + "description": "Resource ID", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionsQuery.json new file mode 100644 index 000000000000..f08b48b38898 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ExternalSubscriptionsQuery.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", + "name": "d99477af-7510-40ee-aca2-e59bdca0d10d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json new file mode 100644 index 000000000000..97aca86314cc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "providers/Microsoft.Billing/billingAccounts/12345", + "parameters": { + "metric": "ActualCost", + "billingPeriod": "202205" + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-11-01", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345", + "requestBody": { + "metric": "ActualCost", + "billingPeriod": "202205" + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json new file mode 100644 index 000000000000..6fa8bed74ffe --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "metric": "ActualCost", + "invoiceId": "M1234567" + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-11-01", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "requestBody": { + "metric": "ActualCost", + "billingPeriod": "202205" + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json new file mode 100644 index 000000000000..7d81223ab415 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", + "parameters": { + "metric": "ActualCost", + "invoiceId": "M1234567" + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-11-01", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", + "requestBody": { + "metric": "ActualCost", + "billingPeriod": "202205" + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json new file mode 100644 index 000000000000..e694cfb49433 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-11-01", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json new file mode 100644 index 000000000000..281c4f8d5a7a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "providers/Microsoft.Billing/departments/12345", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-11-01", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/departments/12345", + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json new file mode 100644 index 000000000000..0648f71f1a42 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "providers/Microsoft.Billing/enrollmentAccounts/1234", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-11-01", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/enrollmentAccounts/1234", + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json new file mode 100644 index 000000000000..61506617c77c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-11-01", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000", + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json new file mode 100644 index 000000000000..2e3b96653d53 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "providers/Microsoft.Billing/billingAccounts/12345", + "parameters": { + "metric": "ActualCost", + "billingPeriod": "202008" + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json new file mode 100644 index 000000000000..db8599d40c64 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "metric": "ActualCost", + "invoiceId": "M1234567" + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json new file mode 100644 index 000000000000..91870502f1ea --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "metric": "ActualCost", + "invoiceId": "M1234567", + "customerId": "456789" + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json new file mode 100644 index 000000000000..8dba7290ddc3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json new file mode 100644 index 000000000000..db094ba0b38c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json new file mode 100644 index 000000000000..3a4e929b2fc3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "operationId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json new file mode 100644 index 000000000000..65038e32eb14 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "operationId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "type": "Microsoft.Consumption/operationStatus", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + }, + "error": { + "code": "0", + "message": null + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateReservationDetailsReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateReservationDetailsReportByBillingAccount.json new file mode 100644 index 000000000000..d0da07f19502 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateReservationDetailsReportByBillingAccount.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "billingAccountId": "9845612", + "startDate": "2020-01-01", + "endDate": "2020-01-30", + "api-version": "2023-11-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "status": "Completed", + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20200911/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2020-09-12T02:56:55.5021869Z" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateReservationDetailsReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateReservationDetailsReportByBillingProfile.json new file mode 100644 index 000000000000..359737a6c9c3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/GenerateReservationDetailsReportByBillingProfile.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "billingAccountId": "00000000-0000-0000-0000-000000000000", + "billingProfileId": "CZSFR-SDFXC-DSDF", + "startDate": "2020-01-01", + "endDate": "2020-01-30", + "api-version": "2023-11-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "status": "Completed", + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20200911/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2020-09-12T02:56:55.5021869Z" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/InvoiceSectionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/InvoiceSectionAlerts.json new file mode 100644 index 000000000000..8e9bfe02811a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/InvoiceSectionAlerts.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/InvoiceSectionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/InvoiceSectionForecast.json new file mode 100644 index 000000000000..cd73833769e7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/InvoiceSectionForecast.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountDimensionsList.json new file mode 100644 index 000000000000..934af8731219 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountDimensionsList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..9a4177e439f4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..6308d523ab95 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountDimensionsListWithFilter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountQuery.json new file mode 100644 index 000000000000..2b142b404787 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountQueryGrouping.json new file mode 100644 index 000000000000..77c4daa89fb6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingAccountQueryGrouping.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileDimensionsList.json new file mode 100644 index 000000000000..e270a6bdb213 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileDimensionsList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..e10cf2b486ad --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileDimensionsListExpandAndTop.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileDimensionsListWithFilter.json new file mode 100644 index 000000000000..5aaedf62d4f2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileDimensionsListWithFilter.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileQuery.json new file mode 100644 index 000000000000..b0afd42764af --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileQueryGrouping.json new file mode 100644 index 000000000000..a67350974048 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCABillingProfileQueryGrouping.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerDimensionsList.json new file mode 100644 index 000000000000..c063668701c7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerDimensionsList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..d64ef080269d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerDimensionsListExpandAndTop.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerDimensionsListWithFilter.json new file mode 100644 index 000000000000..9fd495aad0d6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerDimensionsListWithFilter.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "customerId": "13579", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerQuery.json new file mode 100644 index 000000000000..90f9dc5b9749 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerQueryGrouping.json new file mode 100644 index 000000000000..ffe1fcd6c380 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCACustomerQueryGrouping.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionDimensionsList.json new file mode 100644 index 000000000000..807a34478327 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionDimensionsList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..ca4367e6312f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json new file mode 100644 index 000000000000..e6edb229d745 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionQuery.json new file mode 100644 index 000000000000..5cdffa663855 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionQuery.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionQueryGrouping.json new file mode 100644 index 000000000000..49a686716730 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/MCAInvoiceSectionQueryGrouping.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupDimensionsList.json new file mode 100644 index 000000000000..f2ef61dc077b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupDimensionsList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..158087912963 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupDimensionsListExpandAndTop.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "MyMgId", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupDimensionsListWithFilter.json new file mode 100644 index 000000000000..7906859b2217 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupDimensionsListWithFilter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "MyMgId", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupQuery.json new file mode 100644 index 000000000000..e8443db0f010 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupQueryGrouping.json new file mode 100644 index 000000000000..842847839864 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ManagementGroupQueryGrouping.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/OperationList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/OperationList.json new file mode 100644 index 000000000000..da2904d53e7e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/OperationList.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "Microsoft.CostManagement/budgets/read", + "name": "Microsoft.CostManagement/budgets/read", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Budgets", + "operation": "List budgets", + "description": "List the budgets by a subscription or a management group." + } + }, + { + "id": "Microsoft.CostManagement/query/action", + "name": "Microsoft.CostManagement/query/action", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Query", + "operation": "Query usage data", + "description": "Query usage data by a scope." + } + }, + { + "id": "Microsoft.CostManagement/exports/read", + "name": "Microsoft.CostManagement/exports/read", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Exports", + "operation": "List exports", + "description": "List the exports by scope." + } + }, + { + "id": "Microsoft.CostManagement/exports/write", + "name": "Microsoft.CostManagement/exports/write", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Exports", + "operation": "Create and update export", + "description": "Create or update the specified export." + } + }, + { + "id": "Microsoft.CostManagement/exports/action", + "name": "Microsoft.CostManagement/exports/action", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Exports", + "operation": "Run export", + "description": "Run the specified export." + } + }, + { + "id": "Microsoft.CostManagement/exports/run/action", + "name": "Microsoft.CostManagement/exports/run/action", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "exports/run", + "operation": "Run exports", + "description": "Run exports." + } + }, + { + "id": "Microsoft.CostManagement/alerts/read", + "name": "Microsoft.CostManagement/alerts/read", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Alerts", + "operation": "List Alerts", + "description": "List alerts." + } + }, + { + "id": "Microsoft.CostManagement/operations/read", + "name": "Microsoft.CostManagement/operations/read", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Operations", + "operation": "List supported operations", + "description": "List all supported operations by Microsoft.CostManagement resource provider." + } + }, + { + "id": "Microsoft.CostManagement/views/action", + "name": "Microsoft.CostManagement/views/action", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Views", + "operation": "Create views", + "description": "Create view." + } + }, + { + "id": "Microsoft.CostManagement/views/write", + "name": "Microsoft.CostManagement/views/write", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Views", + "operation": "Update views", + "description": "Update view." + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PricesheetDownload.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PricesheetDownload.json new file mode 100644 index 000000000000..c1535764f4cd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PricesheetDownload.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountName": "7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31", + "billingProfileName": "2USN-TPCD-BG7-TGB", + "invoiceName": "T000940677" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2023-11-01&OperationType=PriceSheet", + "Retry-After": "60", + "OData-EntityId": "45000000-0000-0000-0000-000000000000" + } + }, + "200": { + "body": { + "downloadUrl": "https://myaccount.blob.core.windows.net/?restype=service&comp=properties&sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", + "expiryTime": "2022-09-30T17:32:28Z" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PricesheetDownloadByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PricesheetDownloadByBillingProfile.json new file mode 100644 index 000000000000..1f8d219be2e2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PricesheetDownloadByBillingProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "billingAccountName": "7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31", + "billingProfileName": "2USN-TPCD-BG7-TGB" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2023-11-01&OperationType=PriceSheet", + "Retry-After": "60", + "OData-EntityId": "45000000-0000-0000-0000-000000000000" + } + }, + "200": { + "body": { + "downloadUrl": "https://myaccount.blob.core.windows.net/?restype=service&comp=properties&sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", + "expiryTime": "2018-07-21T17:32:28Z" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateView.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateView.json new file mode 100644 index 000000000000..4c4681f2db41 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateView.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "viewName": "swaggerExample" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateViewCreateOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateViewCreateOrUpdate.json new file mode 100644 index 000000000000..cf0267cb77db --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateViewCreateOrUpdate.json @@ -0,0 +1,185 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "viewName": "swaggerExample", + "parameters": { + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "200": { + "body": { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateViewDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateViewDelete.json new file mode 100644 index 000000000000..6c075fe8cf9d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateViewDelete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "viewName": "TestView" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateViewList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateViewList.json new file mode 100644 index 000000000000..fe1ca9202418 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/PrivateViewList.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + }, + { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample2", + "name": "swaggerExample2", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example 2", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "LastMonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "GroupedColumn", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupAlerts.json new file mode 100644 index 000000000000..0448eb1cf4b2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupDimensionsList.json new file mode 100644 index 000000000000..6615bd57e5be --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupDimensionsList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "system.orlando", + "$expand": "properties/data", + "$top": 5, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.storage/storageaccounts" + ], + "total": 1, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/authprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/systemevents", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/armadminprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/publicsystemportal" + ], + "total": 27, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupForecast.json new file mode 100644 index 000000000000..640f35d80188 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupForecast.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupQuery.json new file mode 100644 index 000000000000..b8fab3380667 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupQuery.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180417, + "USD" + ], + [ + 20.10333307059661, + "ScreenSharingTest-peer", + 20180418, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupQueryGrouping.json new file mode 100644 index 000000000000..3226ef794583 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ResourceGroupQueryGrouping.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceType" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceType", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "Microsoft.SqlServer", + 20180417, + "USD" + ], + [ + 20.10333307059661, + "Microsoft.Compute", + 20180418, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SingleResourceGroupAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SingleResourceGroupAlert.json new file mode 100644 index 000000000000..c056a996c03a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SingleResourceGroupAlert.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "alertId": "22222222-2222-2222-2222-222222222222" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SingleSubscriptionAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SingleSubscriptionAlert.json new file mode 100644 index 000000000000..c5a428885a91 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SingleSubscriptionAlert.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "alertId": "22222222-2222-2222-2222-222222222222" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionAlerts.json new file mode 100644 index 000000000000..467270af1ee9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionDimensionsList.json new file mode 100644 index 000000000000..5bf24fd325d8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionDimensionsList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$top": 5, + "$expand": "properties/data", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "dcrg", + "rg", + "offlinegalleryrg", + "system.orlando.adminkeyvault", + "system.orlando.keyvault" + ], + "total": 68, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.storage/storageaccounts", + "microsoft.web.admin/role", + "microsoft.sql/servers", + "microsoft.compute/virtualmachines" + ], + "total": 4, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionForecast.json new file mode 100644 index 000000000000..0c3c4d34dced --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionForecast.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionQuery.json new file mode 100644 index 000000000000..c621fbfa0f1b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180331, + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod", + 20180331, + "USD" + ], + [ + 0.14384913581657052, + "ssbciotelement01", + 20180401, + "USD" + ], + [ + 0.009865586851323632, + "ict_stratandplan_goldsprova_prod", + 20180429, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionQueryGrouping.json new file mode 100644 index 000000000000..0209b60bc5e1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/SubscriptionQueryGrouping.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 0.009865586851323632, + "Ict_StratAndPlan_GoldSprova_Prod_0", + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod_1", + "USD" + ], + [ + 2.10333307059661, + "ScreenSharingTest-peer1", + "USD" + ], + [ + 0.14384913581657052, + "Ssbciotelement01", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewByResourceGroup.json new file mode 100644 index 000000000000..1fc48fddc860 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewByResourceGroup.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "viewName": "swaggerExample", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewCreateOrUpdateByResourceGroup.json new file mode 100644 index 000000000000..997a0993a255 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewCreateOrUpdateByResourceGroup.json @@ -0,0 +1,186 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "swaggerExample", + "parameters": { + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewDeleteByResourceGroup.json new file mode 100644 index 000000000000..23e4698f3f30 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewDeleteByResourceGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "TestView" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewListByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewListByResourceGroup.json new file mode 100644 index 000000000000..329506c3e467 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/ViewListByResourceGroup.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample2", + "name": "swaggerExample2", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example 2", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "LastMonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "GroupedColumn", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json new file mode 100644 index 000000000000..68204f517c83 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "checkNameAvailabilityRequest": { + "name": "testName", + "type": "Microsoft.CostManagement/ScheduledActions" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "A private scheduled action with name 'testName' is already present. Please specify a differnt name." + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json new file mode 100644 index 000000000000..48d8e670ee13 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "checkNameAvailabilityRequest": { + "name": "testName", + "type": "Microsoft.CostManagement/ScheduledActions" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json new file mode 100644 index 000000000000..36398948b919 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-createOrUpdate-private.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "name": "monthlyCostByResource", + "If-Match": "", + "scheduledAction": { + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "language": "fr", + "regionalFormat": "fr", + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "language": "fr", + "regionalFormat": "fr", + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "scope": "", + "status": "Enabled", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json new file mode 100644 index 000000000000..a3238efadaf4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "name": "monthlyCostByResource", + "If-Match": "", + "scheduledAction": { + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "fileDestination": { + "fileFormats": [ + "Csv" + ] + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "fileDestination": { + "fileFormats": [ + "Csv" + ] + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-delete-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-delete-private.json new file mode 100644 index 000000000000..f06c6c0e07b8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-delete-private.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "name": "monthlyCostByResource" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-delete-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-delete-shared.json new file mode 100644 index 000000000000..0ae91a41d7da --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-delete-shared.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "name": "monthlyCostByResource" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-get-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-get-private.json new file mode 100644 index 000000000000..dc7735be3370 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-get-private.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "name": "monthlyCostByResource" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-get-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-get-shared.json new file mode 100644 index 000000000000..22394ac544a8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-get-shared.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "name": "monthlyCostByResource" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json new file mode 100644 index 000000000000..40429e05921e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "name": "dailyAnomalyByResource", + "If-Match": "", + "scheduledAction": { + "kind": "InsightAlert", + "properties": { + "displayName": "Daily anomaly by resource", + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost anomaly detected in the resource" + }, + "schedule": { + "frequency": "Daily", + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource", + "name": "dailyAnomalyByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "InsightAlert", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily anomaly by resource", + "fileDestination": { + "fileFormats": [] + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost anomaly detected in the resource" + }, + "schedule": { + "frequency": "Daily", + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource", + "name": "dailyAnomalyByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "InsightAlert", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily anomaly by resource", + "fileDestination": { + "fileFormats": [] + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost anomaly detected in the resource" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "schedule": { + "frequency": "Daily", + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-sendNow-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-sendNow-private.json new file mode 100644 index 000000000000..42690c01289f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-sendNow-private.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "name": "monthlyCostByResource" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-sendNow-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-sendNow-shared.json new file mode 100644 index 000000000000..92c65b1a244b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledAction-sendNow-shared.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "name": "monthlyCostByResource" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-list-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-list-private.json new file mode 100644 index 000000000000..7097cde16465 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-list-private.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + }, + { + "id": "providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d15\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily Cost By Resource", + "scope": "", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Daily Cost By Resource" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-list-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-list-shared.json new file mode 100644 index 000000000000..13f6b3bce0f9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-list-shared.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d15\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Daily Cost By Resource" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-listWithFilter-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-listWithFilter-private.json new file mode 100644 index 000000000000..c238936f9aba --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-listWithFilter-private.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "$filter": "properties/viewId eq '/providers/Microsoft.CostManagement/views/swaggerExample'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + }, + { + "id": "providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d15\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily Cost By Resource", + "scope": "", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Daily Cost By Resource" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-listWithFilter-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-listWithFilter-shared.json new file mode 100644 index 000000000000..dbdc9e2e809e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/scheduledActions/scheduledActions-listWithFilter-shared.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "$filter": "properties/viewId eq '/providers/Microsoft.CostManagement/views/swaggerExample'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d15\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Daily Cost By Resource" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/setting-delete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/setting-delete.json new file mode 100644 index 000000000000..f62f8f3f8740 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/setting-delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "type": "taginheritance" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/setting-get.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/setting-get.json new file mode 100644 index 000000000000..111329b5a1a8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/setting-get.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "type": "taginheritance" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", + "name": "taginheritance", + "type": "Microsoft.CostManagement/Settings", + "kind": "taginheritance", + "properties": { + "preferContainerTags": false + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/settings-createOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/settings-createOrUpdate.json new file mode 100644 index 000000000000..3f83048520ef --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/settings-createOrUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "type": "taginheritance", + "setting": { + "kind": "taginheritance", + "properties": { + "preferContainerTags": false + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", + "name": "taginheritance", + "type": "Microsoft.CostManagement/Settings", + "kind": "taginheritance", + "properties": { + "preferContainerTags": false + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", + "name": "taginheritance", + "type": "Microsoft.CostManagement/Settings", + "kind": "taginheritance", + "properties": { + "preferContainerTags": false + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/settingsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/settingsList.json new file mode 100644 index 000000000000..43a352aab2e2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/examples/settingsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/settings/taginheritance", + "name": "taginheritance", + "type": "Microsoft.CostManagement/Settings", + "kind": "taginheritance", + "properties": { + "preferContainerTags": false + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/scheduledActions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/scheduledActions.json new file mode 100644 index 000000000000..1ba0c312033e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/scheduledActions.json @@ -0,0 +1,932 @@ +{ + "swagger": "2.0", + "info": { + "title": "CostManagementClient", + "version": "2023-11-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.CostManagement/scheduledActions": { + "get": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_List", + "description": "List all private scheduled actions.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "PrivateScheduledActionsList": { + "$ref": "./examples/scheduledActions/scheduledActions-list-private.json" + }, + "PrivateScheduledActionsListFilterByViewId": { + "$ref": "./examples/scheduledActions/scheduledActions-listWithFilter-private.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledActionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/scheduledActions": { + "get": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_ListByScope", + "description": "List all shared scheduled actions within the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "ScheduledActionsListByScope": { + "$ref": "./examples/scheduledActions/scheduledActions-list-shared.json" + }, + "ScheduledActionsListByScopeFilterByViewId": { + "$ref": "./examples/scheduledActions/scheduledActions-listWithFilter-shared.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledActionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.CostManagement/scheduledActions/{name}": { + "put": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_CreateOrUpdate", + "description": "Create or update a private scheduled action.", + "x-ms-examples": { + "CreateOrUpdatePrivateScheduledAction": { + "$ref": "./examples/scheduledActions/scheduledAction-createOrUpdate-private.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "scheduledAction", + "description": "Scheduled action to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + { + "$ref": "#/parameters/IfMatchOptionalParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + }, + "get": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_Get", + "description": "Get the private scheduled action by name.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "PrivateScheduledAction": { + "$ref": "./examples/scheduledActions/scheduledAction-get-private.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + }, + "delete": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_Delete", + "description": "Delete a private scheduled action.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "PrivateScheduledActionDelete": { + "$ref": "./examples/scheduledActions/scheduledAction-delete-private.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}": { + "put": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_CreateOrUpdateByScope", + "description": "Create or update a shared scheduled action within the given scope.", + "x-ms-examples": { + "CreateOrUpdateScheduledActionByScope": { + "$ref": "./examples/scheduledActions/scheduledAction-createOrUpdate-shared.json" + }, + "CreateOrUpdateInsightAlertScheduledActionByScope": { + "$ref": "./examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "scheduledAction", + "description": "Scheduled action to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + { + "$ref": "#/parameters/IfMatchOptionalParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + }, + "get": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_GetByScope", + "description": "Get the shared scheduled action from the given scope by name.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "ScheduledActionByScope": { + "$ref": "./examples/scheduledActions/scheduledAction-get-shared.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + }, + "delete": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_DeleteByScope", + "description": "Delete a scheduled action within the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "ScheduledActionDeleteByScope": { + "$ref": "./examples/scheduledActions/scheduledAction-delete-shared.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/scheduledActions/{name}/execute": { + "post": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_Run", + "description": "Processes a private scheduled action.", + "x-ms-examples": { + "ScheduledActionSendNow": { + "$ref": "./examples/scheduledActions/scheduledAction-sendNow-private.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded. It might take up to an hour to receive the email." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}/execute": { + "post": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_RunByScope", + "description": "Runs a shared scheduled action within the given scope.", + "x-ms-examples": { + "ScheduledActionRunByScope": { + "$ref": "./examples/scheduledActions/scheduledAction-sendNow-shared.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded. It might take up to an hour to receive cost analysis information." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/checkNameAvailability": { + "post": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_CheckNameAvailability", + "description": "Checks availability and correctness of the name for a scheduled action.", + "x-ms-examples": { + "ScheduledActionCheckNameAvailability": { + "$ref": "./examples/scheduledActions/checkNameAvailability-private-scheduledAction.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityRequest", + "description": "Scheduled action to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Response of scheduled action name availability.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/checkNameAvailability": { + "post": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_CheckNameAvailabilityByScope", + "description": "Checks availability and correctness of the name for a scheduled action within the given scope.", + "x-ms-examples": { + "ScheduledActionCheckNameAvailabilityByScope": { + "$ref": "./examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityRequest", + "description": "Scheduled action to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Response of scheduled action name availability.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + } + }, + "definitions": { + "DaysOfWeek": { + "type": "string", + "description": "Days of Week.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DaysOfWeek", + "modelAsString": true + } + }, + "FileDestination": { + "type": "object", + "description": "Destination of the view data. This is optional. Currently only CSV format is supported.", + "properties": { + "fileFormats": { + "type": "array", + "description": "Destination of the view data. Currently only CSV format is supported.", + "items": { + "$ref": "#/definitions/FileFormat" + } + } + } + }, + "FileFormat": { + "type": "string", + "description": "Destination of the view data. Currently only CSV format is supported.", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "FileFormat", + "modelAsString": true + } + }, + "Language": { + "type": "string", + "description": "Language in which the email is localized, for ex: 'Fr'. When the specified language is not supported, email will be in english. The supported languages are cs (Czech), da (Danish), de (German), en (English), es (Spanish), fr (French), hu (Hungarian), id (Indonesian), it (Lithuanian), ja (Japanese), ko (Korean), nb (Norwegian Bokmål), nl (Dutch), pl (Polish), pt (Portuguese), ru (Russian), sv (Swedish), tr (Turkish), zh (Chinese) " + }, + "NotificationEmail": { + "type": "string", + "description": "Email address of the point of contact that should get the unsubscribe requests and notification emails." + }, + "NotificationProperties": { + "type": "object", + "description": "The properties of the scheduled action notification.", + "required": [ + "to", + "subject" + ], + "properties": { + "to": { + "description": "Array of email addresses.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" + }, + "minItems": 1, + "maxItems": 20 + }, + "language": { + "description": "Locale of the email.", + "$ref": "#/definitions/Language" + }, + "message": { + "description": "Optional message to be added in the email. Length is limited to 250 characters.", + "type": "string" + }, + "regionalFormat": { + "description": "Regional format used for formatting date/time and currency values in the email.", + "$ref": "#/definitions/RegionalFormat" + }, + "subject": { + "description": "Subject of the email. Length is limited to 70 characters.", + "type": "string" + } + } + }, + "RegionalFormat": { + "type": "string", + "description": "Language for formatting the date/time and currency values in the email. For ex: 'fr'. Defaulted to English, when the specified regional format is not supported. " + }, + "ScheduledActionProxyResource": { + "description": "The Resource model definition.", + "properties": { + "eTag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag. For update calls, eTag is optional and can be specified to achieve optimistic concurrency. Fetch the resource's eTag by doing a 'GET' call first and then including the latest eTag as part of the request body or 'If-Match' header while performing the update. For create calls, eTag is not required." + }, + "kind": { + "$ref": "#/definitions/ScheduledActionKind", + "description": "Kind of the scheduled action." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Kind of the scheduled action." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "type": "object", + "x-ms-azure-resource": true + }, + "ScheduledAction": { + "description": "Scheduled action definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduledActionProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduledActionProperties", + "title": "Scheduled action properties" + } + } + }, + "ScheduledActionKind": { + "type": "string", + "description": "Kind of the scheduled action.", + "enum": [ + "Email", + "InsightAlert" + ], + "x-ms-enum": { + "name": "ScheduledActionKind", + "modelAsString": true, + "values": [ + { + "value": "Email", + "description": "Cost analysis data will be emailed.", + "name": "Email" + }, + { + "value": "InsightAlert", + "description": "Cost anomaly information will be emailed. Available only on subscription scope at daily frequency. If no anomaly is detected on the resource, an email won't be sent.", + "name": "InsightAlert" + } + ] + } + }, + "ScheduledActionListResult": { + "description": "Scheduled actions list result. It contains a list of scheduled actions.", + "type": "object", + "properties": { + "value": { + "description": "The list of scheduled actions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ScheduledActionProperties": { + "type": "object", + "description": "The properties of the scheduled action.", + "required": [ + "displayName", + "notification", + "schedule", + "status", + "viewId" + ], + "properties": { + "displayName": { + "description": "Scheduled action name.", + "type": "string" + }, + "fileDestination": { + "description": "Destination format of the view data. This is optional.", + "$ref": "#/definitions/FileDestination" + }, + "notification": { + "description": "Notification properties based on scheduled action kind.", + "$ref": "#/definitions/NotificationProperties" + }, + "notificationEmail": { + "description": "Email address of the point of contact that should get the unsubscribe requests and notification emails.", + "$ref": "#/definitions/NotificationEmail" + }, + "schedule": { + "description": "Schedule of the scheduled action.", + "$ref": "#/definitions/ScheduleProperties" + }, + "scope": { + "description": "For private scheduled action(Create or Update), scope will be empty.
For shared scheduled action(Create or Update By Scope), Cost Management scope can be 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/ScheduledActionStatus", + "description": "Status of the scheduled action." + }, + "viewId": { + "description": "Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'", + "type": "string" + } + } + }, + "ScheduledActionStatus": { + "type": "string", + "description": "Status of the scheduled action.", + "enum": [ + "Enabled", + "Expired", + "Disabled" + ], + "x-ms-enum": { + "name": "ScheduledActionStatus", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "Scheduled action is saved but will not be run.", + "name": "Disabled" + }, + { + "value": "Enabled", + "description": "Scheduled action is saved and will be run.", + "name": "Enabled" + }, + { + "value": "Expired", + "description": "Scheduled action is expired.", + "name": "Expired" + } + ] + } + }, + "ScheduleFrequency": { + "type": "string", + "description": "Frequency of the schedule.", + "enum": [ + "Daily", + "Weekly", + "Monthly" + ], + "x-ms-enum": { + "name": "ScheduleFrequency", + "modelAsString": true, + "values": [ + { + "value": "Daily", + "description": "Cost analysis data will be emailed every day.", + "name": "Daily" + }, + { + "value": "Weekly", + "description": "Cost analysis data will be emailed every week.", + "name": "Weekly" + }, + { + "value": "Monthly", + "description": "Cost analysis data will be emailed every month.", + "name": "Monthly" + } + ] + } + }, + "ScheduleProperties": { + "type": "object", + "description": "The properties of the schedule.", + "required": [ + "endDate", + "frequency", + "startDate" + ], + "properties": { + "frequency": { + "$ref": "#/definitions/ScheduleFrequency", + "description": "Frequency of the schedule." + }, + "hourOfDay": { + "type": "integer", + "description": "UTC time at which cost analysis data will be emailed.", + "format": "int32" + }, + "daysOfWeek": { + "description": "Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.", + "type": "array", + "items": { + "$ref": "#/definitions/DaysOfWeek" + } + }, + "weeksOfMonth": { + "description": "Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.", + "type": "array", + "items": { + "$ref": "#/definitions/WeeksOfMonth" + } + }, + "dayOfMonth": { + "type": "integer", + "description": "UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.", + "format": "int32" + }, + "startDate": { + "description": "The start date and time of the scheduled action (UTC).", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The end date and time of the scheduled action (UTC).", + "type": "string", + "format": "date-time" + } + } + }, + "WeeksOfMonth": { + "type": "string", + "description": "Weeks of month.", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "WeeksOfMonth", + "modelAsString": true + } + } + }, + "parameters": { + "scopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with scheduled action operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope.", + "x-ms-parameter-location": "method" + }, + "scheduledActionNameParameter": { + "name": "name", + "in": "path", + "description": "Scheduled action name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "IfMatchOptionalParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "description": "ETag of the Entity. Not required when creating an entity. Optional when updating an entity and can be specified to achieve optimistic concurrency.", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/settings.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/settings.json new file mode 100644 index 000000000000..db0ec0b6b979 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2023-11-01/settings.json @@ -0,0 +1,316 @@ +{ + "swagger": "2.0", + "info": { + "title": "CostManagementClient", + "version": "2023-11-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.CostManagement/settings": { + "get": { + "tags": [ + "Settings" + ], + "operationId": "Settings_List", + "description": "List all cost management settings in the requested scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "SettingsList": { + "$ref": "./examples/settingsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeSettingParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SettingsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/settings/{type}": { + "put": { + "tags": [ + "Settings" + ], + "operationId": "Settings_CreateOrUpdateByScope", + "description": "Create or update a setting within the given scope.", + "x-ms-examples": { + "CreateOrUpdateSettingByScope": { + "$ref": "./examples/settings-createOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeSettingParameter" + }, + { + "$ref": "#/parameters/settingTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "setting", + "description": "Setting to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Setting" + } + } + ], + "responses": { + "201": { + "description": "Setting Created.", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "200": { + "description": "Setting Updated.", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Settings" + ], + "operationId": "Settings_GetByScope", + "description": "Get the setting from the given scope by name.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "SettingByScope": { + "$ref": "./examples/setting-get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeSettingParameter" + }, + { + "$ref": "#/parameters/settingTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Settings" + ], + "operationId": "Settings_DeleteByScope", + "description": "Delete a setting within the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "SettingDeleteByScope": { + "$ref": "./examples/setting-delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeSettingParameter" + }, + { + "$ref": "#/parameters/settingTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Setting deleted successfully." + }, + "204": { + "description": "Setting is already deleted or not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Setting": { + "description": "Setting definition.", + "discriminator": "kind", + "type": "object", + "x-ms-azure-resource": true, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "type": "string", + "description": "Specifies the kind of settings.", + "enum": [ + "taginheritance" + ], + "x-ms-enum": { + "name": "SettingsKind", + "modelAsString": true + } + } + }, + "required": [ + "kind" + ] + }, + "TagInheritanceSetting": { + "description": "Tag Inheritance Setting definition.", + "type": "object", + "x-ms-discriminator-value": "taginheritance", + "allOf": [ + { + "$ref": "#/definitions/Setting" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TagInheritanceProperties" + } + } + }, + "SettingsListResult": { + "description": "Setting list result. It contains a list of settings.", + "type": "object", + "properties": { + "value": { + "description": "The list of settings.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Setting" + }, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "TagInheritanceProperties": { + "type": "object", + "description": "The properties of the tag inheritance setting.", + "required": [ + "preferContainerTags" + ], + "properties": { + "preferContainerTags": { + "description": "When resource has the same tag as subscription or resource group and this property is set to true - the subscription or resource group tag will be applied. If subscription and resource group tags are also the same, subscription tag will be applied.", + "type": "boolean" + } + } + } + }, + "parameters": { + "scopeSettingParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with this setting. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope.", + "x-ms-parameter-location": "method" + }, + "settingTypeParameter": { + "name": "type", + "in": "path", + "description": "Setting type.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "enum": [ + "taginheritance" + ], + "x-ms-enum": { + "name": "SettingType", + "modelAsString": true, + "values": [ + { + "value": "taginheritance", + "description": "This setting applies, all the resource group and subscription tags to usage data of child resources. Inherited tags will be seen within 24 hours for the current month's usage data.", + "name": "taginheritance" + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index 2dd25e9bc68d..c95d46fe86d4 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -26,18 +26,36 @@ These are the global settings for the Cost Management API. ``` yaml openapi-type: arm -tag: package-2023-08 +tag: package-2023-11 azure-validator: false ``` --- +### Tag: package-2023-11 + +These settings apply only when `--tag=package-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-2023-11' +input-file: + - Microsoft.CostManagement/stable/2023-11-01/common-types.json + - Microsoft.CostManagement/stable/2023-11-01/costallocation.json + - Microsoft.CostManagement/stable/2023-11-01/costmanagement.benefits.json + - Microsoft.CostManagement/stable/2023-11-01/costmanagement.budgets.json + - Microsoft.CostManagement/stable/2023-11-01/costmanagement.exports.json + - Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatecostdetailsreport.json + - Microsoft.CostManagement/stable/2023-11-01/costmanagement.generatedetailedcostreport.json + - Microsoft.CostManagement/stable/2023-11-01/costmanagement.json + - Microsoft.CostManagement/stable/2023-11-01/costmanagement.pricesheets.json + - Microsoft.CostManagement/stable/2023-11-01/scheduledActions.json + - Microsoft.CostManagement/stable/2023-11-01/settings.json +``` ### Tag: package-2023-08 These settings apply only when `--tag=package-2023-08` is specified on the command line. -```yaml $(tag) == 'package-2023-08' +``` yaml $(tag) == 'package-2023-08' input-file: - Microsoft.CostManagement/stable/2023-08-01/common-types.json - Microsoft.CostManagement/stable/2023-08-01/costmanagement.benefits.json @@ -51,6 +69,7 @@ input-file: - Microsoft.CostManagement/stable/2023-08-01/costallocation.json - Microsoft.CostManagement/stable/2023-08-01/settings.json ``` + ### Tag: package-2023-03 These settings apply only when `--tag=package-2023-03` is specified on the command line. diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index e8091e577224..4e21c29e8722 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -38,7 +38,7 @@ }, "schema": { "type": "object", - "x-ms-format": "dfe-list-generic", + "x-ms-format": "dfe-object", "x-ms-format-element-type": "DatasetSchemaDataElement", "description": "Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement." }, diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json index 0e5dc7dc7cf6..60fea2a94ab0 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json @@ -478,12 +478,14 @@ "type": "object", "properties": { "targetName": { - "description": "The server name of data source access.", - "type": "object" + "description": "The server name of data source access. Type: string.", + "type": "object", + "x-ms-format": "dfe-string" }, "userName": { - "description": "The user name of data source access.", - "type": "object" + "description": "The user name of data source access. Type: string.", + "type": "object", + "x-ms-format": "dfe-string" }, "password": { "description": "The password of data source access.", 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 50c721b67e69..15e195fe1943 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 @@ -2203,8 +2203,8 @@ }, "authHeaders": { "type": "object", - "x-ms-format": "dfe-object", - "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object)." + "x-ms-format": "dfe-key-value-pairs", + "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type)." }, "tenant": { "type": "object", @@ -4003,8 +4003,8 @@ }, "authHeaders": { "type": "object", - "x-ms-format": "dfe-object", - "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object)." + "x-ms-format": "dfe-key-value-pairs", + "description": "The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type)." }, "embeddedCertData": { "type": "object", @@ -6369,8 +6369,8 @@ "properties": { "clusterSize": { "type": "object", - "x-ms-format": "dfe-string", - "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-int", + "description": "Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int)." }, "timeToLive": { "type": "object", @@ -7322,8 +7322,9 @@ "type": "object", "properties": { "functionAppUrl": { - "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net.", - "type": "object" + "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net. Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "functionKey": { "description": "Function or Host key for Azure Function App.", @@ -7338,8 +7339,9 @@ "description": "The credential reference containing authentication information." }, "resourceId": { - "description": "Allowed token audiences for azure function.", - "type": "object" + "description": "Allowed token audiences for azure function. Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "authentication": { "type": "object", @@ -7377,7 +7379,8 @@ "properties": { "connectionString": { "description": "The connection string of snowflake. Type: string, SecureString.", - "type": "object" + "type": "object", + "x-ms-format": "dfe-string" }, "password": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 5376918c0ea5..775663a76219 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -2640,8 +2640,8 @@ }, "additionalHeaders": { "type": "object", - "x-ms-format": "dfe-string", - "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-key-value-pairs", + "description": "The additional HTTP headers in the request to the RESTful API. Type: key value pairs (value should be string type)." }, "httpRequestTimeout": { "type": "object", @@ -2654,7 +2654,8 @@ }, "httpCompressionType": { "type": "object", - "description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. " + "x-ms-format": "dfe-string", + "description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. Type: string (or Expression with resultType string)." } } }, @@ -2698,7 +2699,8 @@ }, "additionalColumns": { "type": "object", - "description": "Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects)." + "x-ms-format": "dfe-key-value-pairs", + "description": "Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type)." } } }, @@ -2731,8 +2733,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2773,8 +2776,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2857,8 +2861,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2899,8 +2904,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -2937,8 +2943,9 @@ "type": "object" }, "partitionOption": { - "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".", - "type": "object" + "description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\". Type: string (or Expression with resultType string).", + "type": "object", + "x-ms-format": "dfe-string" }, "partitionSettings": { "description": "The settings that will be leveraged for Sql source partitioning.", @@ -4754,7 +4761,8 @@ }, "writeBehavior": { "type": "object", - "description": "Write behavior when copying data into sql. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + "x-ms-format": "dfe-string", + "description": "Write behavior when copying data into sql. Type: string (or Expression with resultType string)." }, "upsertSettings": { "description": "SQL upsert settings.", @@ -4808,7 +4816,8 @@ }, "writeBehavior": { "type": "object", - "description": "Write behavior when copying data into sql server. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + "x-ms-format": "dfe-string", + "description": "Write behavior when copying data into sql server. Type: string (or Expression with resultType string)." }, "upsertSettings": { "description": "SQL upsert settings.", @@ -4916,7 +4925,8 @@ }, "writeBehavior": { "type": "object", - "description": "White behavior when copying data into azure SQL MI. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum)" + "x-ms-format": "dfe-string", + "description": "White behavior when copying data into azure SQL MI. Type: string (or Expression with resultType string)" }, "upsertSettings": { "description": "SQL upsert settings.", @@ -5966,6 +5976,7 @@ }, "arguments": { "type": "object", + "x-ms-format": "dfe-list-string", "description": "User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array)." }, "getDebugInfo": { @@ -6996,8 +7007,8 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-string", - "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-key-value-pairs", + "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: dictionary (or Expression with resultType dictionary)." }, "body": { "type": "object", @@ -7012,6 +7023,15 @@ "type": "boolean", "description": "When set to true, Certificate validation will be disabled." }, + "httpRequestTimeout": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes" + }, + "turnOffAsync": { + "type": "boolean", + "description": "Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers." + }, "datasets": { "type": "array", "description": "List of datasets passed to web endpoint.", @@ -7421,8 +7441,7 @@ "type": "object" }, "dataPathAssignments": { - "x-ms-format": "dfe-key-value-pairs", - "description": "Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object).", + "description": "Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object (or Expression with resultType object).", "type": "object" }, "mlParentRunId": { @@ -8026,8 +8045,8 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-string", - "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-key-value-pairs", + "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: dictionary (or Expression with resultType dictionary)." }, "body": { "type": "object", @@ -8092,8 +8111,8 @@ }, "headers": { "type": "object", - "x-ms-format": "dfe-string", - "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)." + "x-ms-format": "dfe-key-value-pairs", + "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: dictionary (or Expression with resultType dictionary)." }, "body": { "type": "object", @@ -8862,6 +8881,7 @@ }, "referenceName": { "type": "object", + "x-ms-format": "dfe-string", "description": "Reference spark job name. Expression with resultType string." } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/Operations/List.json deleted file mode 100644 index 006d47be7be1..000000000000 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/Operations/List.json +++ /dev/null @@ -1,533 +0,0 @@ -{ - "parameters": { - "api-version": "2023-08-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.DataProtection/locations/getBackupStatus/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Status", - "operation": "Check Backup Status for Vault", - "description": "Check Backup Status for Recovery Services Vaults" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/write", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Create a Backup Instance", - "description": "Creates a Backup Instance" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/delete", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Delete Backup Instance", - "description": "Deletes the Backup Instance" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Get Backup Instance Details", - "description": "Returns details of the Backup Instance" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Get Backup Instances", - "description": "Returns all Backup Instances" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/backup/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Backup Backup Instance", - "description": "Performs Backup on the Backup Instance" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/sync/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Sync Backup Instance", - "description": "Sync operation retries last failed operation on backup instance to bring it to a valid state." - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/operationResults/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Get Backup Operation Result", - "description": "Returns Backup Operation Result for Backup Vault." - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Stop Protection of Backup Instance", - "description": "Stop Protection operation stops both backup and retention schedules of backup instance. Existing data will be retained forever." - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Suspend Backups of Backup Instance", - "description": "Suspend Backups operation stops only backups of backup instance. Retention activities will continue and hence data will be ratained as per policy." - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Resume Protection of Backup Instance", - "description": "Resume protection of a ProtectionStopped BI." - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Resume Backups of Backup Instance", - "description": "Resume Backups for a BackupsSuspended BI." - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Validate for Restore of Backup Instance", - "description": "Validates for Restore of the Backup Instance" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/restore/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Instance", - "operation": "Restore Backup Instance", - "description": "Triggers restore on the Backup Instance" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupPolicies/write", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Policies", - "operation": "Create Backup Policy", - "description": "Creates Backup Policy" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupPolicies/delete", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Policies", - "operation": "Delete Backup Policy", - "description": "Deletes the Backup Policy" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Policies", - "operation": "Get Backup Policy details", - "description": "Returns details of the Backup Policy" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Policies", - "operation": "Get Backup Policies", - "description": "Returns all Backup Policies" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guard Proxy", - "operation": "Get the list of ResourceGuard proxies for a resource", - "description": "Get the list of ResourceGuard proxies for a resource" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guard Proxy", - "operation": "Get ResourceGuard proxy", - "description": "Get ResourceGuard proxy operation gets an object representing the Azure resource of type 'ResourceGuard proxy'" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/write", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guard Proxy", - "operation": "Create ResourceGuard proxy", - "description": "Create ResourceGuard proxy operation creates an Azure resource of type 'ResourceGuard Proxy'" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guard Proxy", - "operation": "Delete ResourceGuard proxy", - "description": "The Delete ResourceGuard proxy operation deletes the specified Azure resource of type 'ResourceGuard proxy'" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/unlockDelete/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guard Proxy", - "operation": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation", - "description": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Recovery Points", - "operation": "Get Recovery Point Details", - "description": "Returns details of the Recovery Point" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Recovery Points", - "operation": "Get Recovery Points", - "description": "Returns all Recovery Points" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Restorable Time Ranges", - "operation": "Find Restorable Time Ranges", - "description": "Finds Restorable Time Ranges" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/write", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Vaults", - "operation": "Create Backup Vault", - "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Vaults", - "operation": "Create Backup Vault", - "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/delete", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Vaults", - "operation": "Create Backup Vault", - "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/operationResults/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Vaults", - "operation": "Get Operation Result of a Patch Operation for a Backup Vault", - "description": "Gets Operation Result of a Patch Operation for a Backup Vault" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/locations/checkNameAvailability/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Vaults", - "operation": "Check if the requested BackupVault Name is Available", - "description": "Checks if the requested BackupVault Name is Available" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Vaults", - "operation": "Get Backup Vaults in a Resource Group", - "description": "Gets list of Backup Vaults in a Resource Group" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Vaults", - "operation": "Get Backup Vaults in a Subscription", - "description": "Gets list of Backup Vaults in a Subscription" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guards", - "operation": "Create ResourceGuard", - "description": "Create ResourceGuard operation creates an Azure resource of type 'ResourceGuard'" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guards", - "operation": "Get ResourceGuard", - "description": "The Get ResourceGuard operation gets an object representing the Azure resource of type 'ResourceGuard'" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guards", - "operation": "Delete ResourceGuard", - "description": "The Delete ResourceGuard operation deletes the specified Azure resource of type 'ResourceGuard'" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guards", - "operation": "Get ResourceGuards in a Resource Group", - "description": "Gets list of ResourceGuards in a Resource Group" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/subscriptions/providers/resourceGuards/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guards", - "operation": "Get ResourceGuards in a Subscription", - "description": "Gets list of ResourceGuards in a Subscription" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guards", - "operation": "Update ResourceGuard", - "description": "Update ResouceGuard operation updates an Azure resource of type 'ResourceGuard'" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guards", - "operation": "Get ResourceGuard operation request info", - "description": "Gets ResourceGuard operation request info" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Guards", - "operation": "Get ResourceGuard default operation request info", - "description": "Gets ResourceGuard default operation request info" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/subscriptions/providers/locations/checkFeatureSupport/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Provider Operation", - "operation": "Validate if a feature is supported", - "description": "Validates if a feature is supported" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/locations/operationStatus/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Operation Status", - "operation": "Get Backup Operation Status", - "description": "Returns Backup Operation Status for Backup Vault." - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/operationStatus/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Operation Status", - "operation": "Get Backup Operation Status", - "description": "Returns Backup Operation Status for Backup Vault." - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/operationStatus/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Operation Status", - "operation": "Get Backup Operation Status", - "description": "Returns Backup Operation Status for Backup Vault." - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/locations/operationResults/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Operation Results", - "operation": "Get Backup Operation Result", - "description": "Returns Backup Operation Result for Backup Vault." - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/validateForBackup/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Validate Backup", - "operation": "Validate for backup of Backup Instance", - "description": "Validates for backup of Backup Instance" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/backupVaults/backupJobs/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Jobs", - "operation": "Backup Jobs", - "description": "Get Jobs list" - }, - "origin": "user" - }, - { - "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Backup Jobs", - "operation": "Backup Job Object", - "description": "Get Job details" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/register/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Provider Operation", - "operation": "Register Resource Provider", - "description": "Registers subscription for given Resource Provider" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/unregister/action", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Provider Operation", - "operation": "Unregister Resource Provider", - "description": "Unregisters subscription for given Resource Provider" - }, - "origin": "user" - }, - { - "name": "Microsoft.DataProtection/operations/read", - "display": { - "provider": "Microsoft.DataProtection", - "resource": "Resource Provider Operation", - "operation": "List of Operations", - "description": "Operation returns the list of Operations for a Resource Provider" - }, - "origin": "user" - } - ] - } - } - } -} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/dataprotection.json similarity index 93% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/dataprotection.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/dataprotection.json index 41875f42705a..d72c8de9a4bc 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/dataprotection.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/dataprotection.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2023-08-01", + "version": "2023-11-01", "title": "DataProtectionBackupClient", "x-ms-code-generation-settings": { "internalConstructors": false @@ -1534,6 +1534,348 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchSecondaryRecoveryPoints": { + "post": { + "tags": [ + "FetchSecondaryRecoveryPoints" + ], + "description": "Returns a list of Secondary Recovery Points for a DataSource in a vault, that can be used for Cross Region Restore.", + "operationId": "FetchSecondaryRecoveryPoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/FetchSecondaryRPsRequestParameters" + } + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupRecoveryPointResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/RecoveryPointsFilters", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Fetch SecondaryRPs": { + "$ref": "./examples/CrossRegionRestore/FetchSecondaryRPs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/crossRegionRestore": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Triggers Cross Region Restore for BackupInstance.", + "operationId": "BackupInstances_TriggerCrossRegionRestore", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for trigger CRR operation", + "required": true, + "schema": { + "$ref": "#/definitions/CrossRegionRestoreRequestObject" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../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": { + "Trigger Cross Region Restore": { + "$ref": "./examples/CrossRegionRestore/TriggerCrossRegionRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/validateCrossRegionRestore": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Validates whether Cross Region Restore can be triggered for DataSource.", + "operationId": "BackupInstances_ValidateCrossRegionRestore", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateCrossRegionRestoreRequestObject" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Validate Cross Region Restore": { + "$ref": "./examples/CrossRegionRestore/ValidateCrossRegionRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchCrossRegionRestoreJob": { + "post": { + "tags": [ + "DppJob" + ], + "description": "Fetches the Cross Region Restore Job", + "operationId": "FetchCrossRegionRestoreJob_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/CrossRegionRestoreJobRequest" + } + } + ], + "responses": { + "200": { + "description": "Details about a Cross Region Restore Job", + "schema": { + "$ref": "#/definitions/AzureBackupJobResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Cross Region Restore Job": { + "$ref": "./examples/CrossRegionRestore/FetchCrossRegionRestoreJob.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchCrossRegionRestoreJobs": { + "post": { + "tags": [ + "DppJob" + ], + "description": "Fetches list of Cross Region Restore job belonging to the vault", + "operationId": "FetchCrossRegionRestoreJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/CrossRegionRestoreJobsRequest" + } + } + ], + "responses": { + "200": { + "description": "List of Cross Region Restore Jobs", + "schema": { + "$ref": "#/definitions/AzureBackupJobResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Cross Region Restore Jobs": { + "$ref": "./examples/CrossRegionRestore/FetchCrossRegionRestoreJobs.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate": { "post": { "description": "rehydrate recovery point for restore for a BackupInstance", @@ -3900,6 +4242,18 @@ "format": "date-time", "type": "string", "readOnly": true + }, + "recoveryPointState": { + "description": "Specifies recovery point completeness. Partial (i.e., only some of the intended items were backed up), or Completed (i.e., ALL intended items were backed up).", + "enum": [ + "Completed", + "Partial" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointCompletionState", + "modelAsString": true + } } }, "required": [ @@ -4148,6 +4502,42 @@ ], "type": "object" }, + "CrossRegionRestoreJobRequest": { + "description": "Details of CRR Job to be fetched", + "required": [ + "sourceRegion", + "sourceBackupVaultId", + "jobId" + ], + "type": "object", + "properties": { + "sourceRegion": { + "type": "string" + }, + "sourceBackupVaultId": { + "type": "string" + }, + "jobId": { + "type": "string" + } + } + }, + "CrossRegionRestoreJobsRequest": { + "description": "Details of Backup Vault for which CRR Jobs are to be fetched", + "required": [ + "sourceRegion", + "sourceBackupVaultId" + ], + "type": "object", + "properties": { + "sourceRegion": { + "type": "string" + }, + "sourceBackupVaultId": { + "type": "string" + } + } + }, "AzureBackupJobResource": { "allOf": [ { @@ -4859,6 +5249,13 @@ "name": "SecureScoreLevel", "modelAsString": true } + }, + "replicatedRegions": { + "description": "List of replicated regions for Backup Vault", + "items": { + "type": "string" + }, + "type": "array" } }, "required": [ @@ -5149,6 +5546,20 @@ "title": "ClientDiscoveryValueForSingleApi", "type": "object" }, + "FetchSecondaryRPsRequestParameters": { + "description": "Information about BI whose secondary RecoveryPoints are requested\r\nSource region and\r\nBI ARM path", + "type": "object", + "properties": { + "sourceRegion": { + "description": "Source region in which BackupInstance is located", + "type": "string" + }, + "sourceBackupInstanceId": { + "description": "ARM Path of BackupInstance", + "type": "string" + } + } + }, "CloudError": { "description": "An error response from Azure Backup.", "properties": { @@ -6128,6 +6539,15 @@ "$ref": "#/definitions/RestoreJobRecoveryPointDetails", "description": "Details of the Target Recovery Point", "readOnly": true + }, + "warningDetails": { + "description": "A List, detailing the warnings related to the job", + "items": { + "$ref": "#/definitions/UserFacingWarningDetail" + }, + "x-ms-identifiers": [], + "readOnly": true, + "type": "array" } }, "type": "object" @@ -6192,6 +6612,58 @@ "objectType" ] }, + "CrossRegionRestoreDetails": { + "description": "Cross Region Restore details", + "required": [ + "sourceRegion", + "sourceBackupInstanceId" + ], + "type": "object", + "properties": { + "sourceRegion": { + "type": "string" + }, + "sourceBackupInstanceId": { + "type": "string" + } + } + }, + "ValidateCrossRegionRestoreRequestObject": { + "description": "Cross Region Restore Request Object", + "required": [ + "restoreRequestObject", + "crossRegionRestoreDetails" + ], + "type": "object", + "properties": { + "restoreRequestObject": { + "$ref": "#/definitions/AzureBackupRestoreRequest", + "description": "Gets or sets the restore request object." + }, + "crossRegionRestoreDetails": { + "$ref": "#/definitions/CrossRegionRestoreDetails", + "description": "Cross region restore details." + } + } + }, + "CrossRegionRestoreRequestObject": { + "description": "Cross Region Restore Request Object", + "required": [ + "restoreRequestObject", + "crossRegionRestoreDetails" + ], + "type": "object", + "properties": { + "restoreRequestObject": { + "$ref": "#/definitions/AzureBackupRestoreRequest", + "description": "Gets or sets the restore request object." + }, + "crossRegionRestoreDetails": { + "$ref": "#/definitions/CrossRegionRestoreDetails", + "description": "Cross region restore details." + } + } + }, "OperationJobExtendedInfo": { "allOf": [ { @@ -6201,7 +6673,7 @@ "description": "Operation Job Extended Info", "properties": { "jobId": { - "description": "Arm Id of the job created for this operation.", + "description": "Name or Arm Id of the job created for this operation.", "type": "string" } }, @@ -7391,6 +7863,23 @@ }, "type": "object" }, + "UserFacingWarningDetail": { + "description": "Warning object used by layers that have access to localized content, and propagate that to user", + "properties": { + "resourceName": { + "description": "Name of resource for which warning is raised.", + "type": "string" + }, + "warning": { + "$ref": "#/definitions/UserFacingError", + "description": "Error details for the warning." + } + }, + "required": [ + "warning" + ], + "type": "object" + }, "ValidateForBackupRequest": { "description": "Validate for backup request", "properties": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/DeleteBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/DeleteBackupInstance.json similarity index 92% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/DeleteBackupInstance.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/DeleteBackupInstance.json index 2b0170b6fbe6..e9c47b1a9845 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/DeleteBackupInstance.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/DeleteBackupInstance.json @@ -4,13 +4,13 @@ "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", "backupInstanceName": "testInstance1", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json similarity index 96% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json index 07e8563c2008..95996f029480 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/FindRestorableTimeRanges.json @@ -4,7 +4,7 @@ "resourceGroupName": "Blob-Backup", "vaultName": "ZBlobBackupVaultBVTD3", "backupInstanceName": "zblobbackuptestsa58", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "sourceDataStoreType": "OperationalStore", "startTime": "2020-10-17T23:28:17.6829685Z", diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/GetBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/GetBackupInstance.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/GetBackupInstance.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/GetBackupInstance.json index 3ad242d0a6ee..df432af1a3c7 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/GetBackupInstance.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/GetBackupInstance.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1" }, "responses": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json similarity index 95% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json index c3c4e1c5969c..6e64ef96c657 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json @@ -5,7 +5,7 @@ "vaultName": "swaggerExample", "backupInstanceName": "testInstance1", "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { @@ -48,8 +48,8 @@ "202": { "headers": { "Retry-After": "10", - "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01", - "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupvaults/swaggerExample/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01" + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupvaults/swaggerExample/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01" } } } diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/GetRecoveryPoint.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/GetRecoveryPoint.json similarity index 94% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/GetRecoveryPoint.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/GetRecoveryPoint.json index 6ae3f2869b53..7480c0f98654 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/GetRecoveryPoint.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/GetRecoveryPoint.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1", "recoveryPointId": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25" }, @@ -31,7 +31,8 @@ "creationTime": "2019-03-01T13:00:00Z", "metaData": "123456" } - ] + ], + "recoveryPointState": "Completed" } } } diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ListBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ListBackupInstances.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ListBackupInstances.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ListBackupInstances.json index 77fa760f35b5..f8d86d7bc982 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ListBackupInstances.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ListBackupInstances.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ListRecoveryPoints.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ListRecoveryPoints.json similarity index 94% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ListRecoveryPoints.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ListRecoveryPoints.json index 0bac2327c7a5..18ac0b1ca4af 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ListRecoveryPoints.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ListRecoveryPoints.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1" }, "responses": { @@ -33,7 +33,8 @@ "creationTime": "2019-03-01T13:00:00Z", "metaData": "123456" } - ] + ], + "recoveryPointState": "Completed" } }, { @@ -58,7 +59,8 @@ "creationTime": "2019-03-01T13:00:00Z", "metaData": "123456" } - ] + ], + "recoveryPointState": "Completed" } } ] diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/PutBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/PutBackupInstance.json similarity index 97% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/PutBackupInstance.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/PutBackupInstance.json index 2b7afd859e46..9c41839d776e 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/PutBackupInstance.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/PutBackupInstance.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1", "parameters": { "tags": { @@ -56,7 +56,7 @@ "responses": { "201": { "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" }, "body": { @@ -109,8 +109,8 @@ }, "202": { "headers": { - "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01", - "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ResumeBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ResumeBackups.json similarity index 91% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ResumeBackups.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ResumeBackups.json index 056bf074ea1e..082c3e5e9e42 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ResumeBackups.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ResumeBackups.json @@ -4,13 +4,13 @@ "resourceGroupName": "testrg", "vaultName": "testvault", "backupInstanceName": "testbi", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "202": { "headers": { - "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ResumeProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ResumeProtection.json similarity index 91% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ResumeProtection.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ResumeProtection.json index 056bf074ea1e..082c3e5e9e42 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ResumeProtection.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ResumeProtection.json @@ -4,13 +4,13 @@ "resourceGroupName": "testrg", "vaultName": "testvault", "backupInstanceName": "testbi", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "202": { "headers": { - "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/StopProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/StopProtection.json similarity index 91% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/StopProtection.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/StopProtection.json index 056bf074ea1e..082c3e5e9e42 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/StopProtection.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/StopProtection.json @@ -4,13 +4,13 @@ "resourceGroupName": "testrg", "vaultName": "testvault", "backupInstanceName": "testbi", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "202": { "headers": { - "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/SuspendBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/SuspendBackups.json similarity index 91% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/SuspendBackups.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/SuspendBackups.json index 056bf074ea1e..082c3e5e9e42 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/SuspendBackups.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/SuspendBackups.json @@ -4,13 +4,13 @@ "resourceGroupName": "testrg", "vaultName": "testvault", "backupInstanceName": "testbi", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "202": { "headers": { - "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/SyncBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/SyncBackupInstance.json similarity index 92% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/SyncBackupInstance.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/SyncBackupInstance.json index 6da59743f8ca..2d3927d3ccaa 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/SyncBackupInstance.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/SyncBackupInstance.json @@ -4,7 +4,7 @@ "resourceGroupName": "testrg", "vaultName": "testvault", "backupInstanceName": "testbi", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "syncType": "Default" } @@ -12,8 +12,8 @@ "responses": { "202": { "headers": { - "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerBackup.json similarity index 94% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerBackup.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerBackup.json index fa4802df8e6c..86c47411083f 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerBackup.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerBackup.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1", "parameters": { "backupRuleOptions": { @@ -17,8 +17,8 @@ "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRehydrate.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRehydrate.json similarity index 93% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRehydrate.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRehydrate.json index 8d4665a00c6c..65b414e04b8e 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRehydrate.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRehydrate.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1", "parameters": { "recoveryPointId": "hardcodedRP", @@ -14,8 +14,8 @@ "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRestore.json similarity index 97% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRestore.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRestore.json index 54341f96bbed..c2d9e1d14d7d 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRestore.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRestore.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1", "parameters": { "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", @@ -45,8 +45,8 @@ "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json similarity index 95% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json index fd0c39a494fe..831d5ac48fca 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1", "parameters": { "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", @@ -25,8 +25,8 @@ "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json similarity index 97% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json index cdf03473139a..309bdee39d2c 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1", "parameters": { "objectType": "AzureBackupRestoreWithRehydrationRequest", @@ -40,8 +40,8 @@ "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ValidateForBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ValidateForBackup.json similarity index 95% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ValidateForBackup.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ValidateForBackup.json index 4109d05492b3..fe2dc5072a52 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ValidateForBackup.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ValidateForBackup.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1", "parameters": { "backupInstance": { @@ -43,8 +43,8 @@ "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ValidateRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ValidateRestore.json similarity index 96% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ValidateRestore.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ValidateRestore.json index 5da30d703eb3..5acb4c99234b 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/BackupInstanceOperations/ValidateRestore.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/BackupInstanceOperations/ValidateRestore.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1", "parameters": { "restoreRequestObject": { @@ -47,8 +47,8 @@ "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/CheckfeatureSupport.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CheckfeatureSupport.json similarity index 96% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/CheckfeatureSupport.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CheckfeatureSupport.json index 5362b9c4eefb..791d8f6f3c33 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/CheckfeatureSupport.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CheckfeatureSupport.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "location": "WestUS", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "featureType": "DataSourceType", "objectType": "FeatureValidationRequest" diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/FetchCrossRegionRestoreJob.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/FetchCrossRegionRestoreJob.json new file mode 100644 index 000000000000..177a40848386 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/FetchCrossRegionRestoreJob.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "resourceGroupName": "BugBash1", + "location": "west us", + "parameters": { + "sourceRegion": "east us", + "sourceBackupVaultId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11", + "jobId": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae" + }, + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2", + "policyName": "jakavetdailypolicy", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb2", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T03:00:03.7604146Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "east us", + "extendedInfo": { + "subTasks": [ + { + "taskId": 1, + "taskName": "Trigger Backup", + "taskStatus": "Started" + } + ], + "additionalDetails": { + "RetentionTag": "Default", + "PolicyRuleName": "BackupWeekly", + "TaskId": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9" + } + } + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/FetchCrossRegionRestoreJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/FetchCrossRegionRestoreJobs.json new file mode 100644 index 000000000000..814f8c51518c --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/FetchCrossRegionRestoreJobs.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "resourceGroupName": "BugBash1", + "location": "east us", + "api-version": "2023-11-01", + "parameters": { + "sourceRegion": "east us", + "sourceBackupVaultId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "activityID": "932925c4-3d81-4550-8105-c7f7b0a934c5", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/3048870f-b1b7-44c4-b078-368da3fd000e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy2", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb4", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb4", + "policyName": "jakavetPolicy2", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb4", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-16T05:00:08.1746833Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/8989416e-7573-4836-8cf1-0e90954f1002", + "name": "8989416e-7573-4836-8cf1-0e90954f1002", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "b4f32e03-ded0-46fc-9afc-91853878efcd", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/943c60db-c033-4d93-bb00-66048474e00e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy3", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb5", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb5", + "policyName": "jakavetPolicy3", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb5", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-16T18:00:03.6660733Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/ad218c05-242a-47c2-b7b7-c16bd0f8870c", + "name": "ad218c05-242a-47c2-b7b7-c16bd0f8870c", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2", + "policyName": "jakavetdailypolicy", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb2", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T03:00:03.7604146Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "94052cf1-a47f-4c1b-93e7-79e07b2bd008-Tue Mar 17 2021 11:11:48 GMT+0530 (India Standard Time)-Ibz", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/0b247869-b8be-4885-b832-8ac4cdf5b00e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy1", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb3", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb3", + "policyName": "jakavetPolicy1", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb3", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T11:11:50.5595259Z", + "endTime": "2021-03-17T11:14:02.5319646Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Succeeded", + "isUserTriggered": true, + "supportedActions": [ + "" + ], + "duration": "00:02:11.9724387", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/43252662-1b43-44fd-a856-0055665cb097", + "name": "43252662-1b43-44fd-a856-0055665cb097", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/FetchSecondaryRPs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/FetchSecondaryRPs.json new file mode 100644 index 000000000000..8bd68063ec52 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/FetchSecondaryRPs.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "api-version": "2023-11-01", + "location": "WestUS", + "parameters": { + "sourceBackupInstanceId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34", + "sourceRegion": "EastUS" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35", + "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints", + "properties": { + "objectType": "AzureBackupDiscreteRecoveryPoint", + "recoveryPointTime": "2019-03-01T13:00:00Z", + "recoveryPointType": "Full", + "friendlyName": "panbha4", + "expiryTime": "2023-03-01T13:00:00Z", + "recoveryPointDataStoresDetails": [ + { + "id": "0ff03512-b333-4509-a6c7-12164c8b1dce", + "type": "Snapshot", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + }, + { + "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1", + "type": "BackupStorage", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + } + ] + } + }, + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints", + "properties": { + "objectType": "AzureBackupDiscreteRecoveryPoint", + "recoveryPointTime": "2019-03-01T13:00:00Z", + "recoveryPointType": "Full", + "friendlyName": "panbha4", + "recoveryPointDataStoresDetails": [ + { + "id": "808cfd30-722e-4bab-85f6-4a9d01ffc6f2", + "type": "Snapshot", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + }, + { + "id": "798cfd30-722e-4bab-85f6-4a9d01ffc6f3", + "type": "BackupStorage", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/TriggerCrossRegionRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/TriggerCrossRegionRestore.json new file mode 100644 index 000000000000..a806a22eaf94 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/TriggerCrossRegionRestore.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "location": "EastAsia", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-11-01", + "backupInstanceName": "testInstance1", + "parameters": { + "restoreRequestObject": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "objectType": "RestoreTargetInfo", + "recoveryOption": "FailIfExists", + "datasourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb", + "resourceName": "targetdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "restoreLocation": "southeastasia" + } + }, + "crossRegionRestoreDetails": { + "sourceRegion": "east asia", + "sourceBackupInstanceId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/BackupInstances/harshitbi1" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/ValidateCrossRegionRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/ValidateCrossRegionRestore.json new file mode 100644 index 000000000000..a806a22eaf94 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/CrossRegionRestore/ValidateCrossRegionRestore.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "location": "EastAsia", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-11-01", + "backupInstanceName": "testInstance1", + "parameters": { + "restoreRequestObject": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "objectType": "RestoreTargetInfo", + "recoveryOption": "FailIfExists", + "datasourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb", + "resourceName": "targetdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "restoreLocation": "southeastasia" + } + }, + "crossRegionRestoreDetails": { + "sourceRegion": "east asia", + "sourceBackupInstanceId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/BackupInstances/harshitbi1" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json index 41d8bfb11999..71f24428726c 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "backupInstanceName": "testInstance1" }, "responses": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json index d52a555dddfd..d731a841be54 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PratikPrivatePreviewVault1", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json similarity index 91% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json index 056bf074ea1e..082c3e5e9e42 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json @@ -4,13 +4,13 @@ "resourceGroupName": "testrg", "vaultName": "testvault", "backupInstanceName": "testbi", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "202": { "headers": { - "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", - "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-08-01", + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-11-01", "Retry-After": "60" } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationResult.json similarity index 97% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationResult.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationResult.json index 74a138fa3f12..512ed1292ad8 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationResult.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationResult.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "location": "WestUS", "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "202": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationStatus.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationStatus.json similarity index 96% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationStatus.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationStatus.json index 68b596810264..708176d7b452 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationStatus.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationStatus.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "location": "WestUS", "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationStatusRGContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationStatusRGContext.json similarity index 96% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationStatusRGContext.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationStatusRGContext.json index 71b299893da2..ea804ccea267 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationStatusRGContext.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationStatusRGContext.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationStatusVaultContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationStatusVaultContext.json similarity index 96% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationStatusVaultContext.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationStatusVaultContext.json index 47ff2a901e03..a3fd1971c23b 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/GetOperationStatusVaultContext.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/GetOperationStatusVaultContext.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "vaultName": "swaggerExample", "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/GetExportJobsOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/GetExportJobsOperationResult.json similarity index 94% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/GetExportJobsOperationResult.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/GetExportJobsOperationResult.json index 55eb4e8bbbdf..50777605e415 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/GetExportJobsOperationResult.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/GetExportJobsOperationResult.json @@ -4,7 +4,7 @@ "resourceGroupName": "SwaggerTestRg", "vaultName": "NetSDKTestRsVault", "operationId": "00000000-0000-0000-0000-000000000000", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { @@ -19,7 +19,7 @@ "202": { "headers": { "Retry-After": 60, - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2023-08-01" + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01" } } } diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/GetJob.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/GetJob.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/GetJob.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/GetJob.json index fe33d1f72829..bdca5f7483a4 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/GetJob.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/GetJob.json @@ -4,7 +4,7 @@ "resourceGroupName": "BugBash1", "vaultName": "BugBashVaultForCCYv11", "jobId": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/ListJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/ListJobs.json similarity index 99% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/ListJobs.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/ListJobs.json index e175b7af61f9..fbe7086775af 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/ListJobs.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/ListJobs.json @@ -3,7 +3,7 @@ "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", "resourceGroupName": "BugBash1", "vaultName": "BugBashVaultForCCYv11", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/TriggerExportJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/TriggerExportJobs.json similarity index 90% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/TriggerExportJobs.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/TriggerExportJobs.json index 601f6d49a90a..4f384daef21a 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/JobCRUD/TriggerExportJobs.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/JobCRUD/TriggerExportJobs.json @@ -3,12 +3,12 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "SwaggerTestRg", "vaultName": "NetSDKTestRsVault", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2023-08-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01", "Retry-After": 60 } }, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/Operations/List.json new file mode 100644 index 000000000000..25455f19f242 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/Operations/List.json @@ -0,0 +1,533 @@ +{ + "parameters": { + "api-version": "2023-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataProtection/locations/getBackupStatus/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Create a Backup Instance", + "description": "Creates a Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Delete Backup Instance", + "description": "Deletes the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Instance Details", + "description": "Returns details of the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Instances", + "description": "Returns all Backup Instances" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/backup/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Backup Backup Instance", + "description": "Performs Backup on the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/sync/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Sync Backup Instance", + "description": "Sync operation retries last failed operation on backup instance to bring it to a valid state." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Stop Protection of Backup Instance", + "description": "Stop Protection operation stops both backup and retention schedules of backup instance. Existing data will be retained forever." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Suspend Backups of Backup Instance", + "description": "Suspend Backups operation stops only backups of backup instance. Retention activities will continue and hence data will be ratained as per policy." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Resume Protection of Backup Instance", + "description": "Resume protection of a ProtectionStopped BI." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Resume Backups of Backup Instance", + "description": "Resume Backups for a BackupsSuspended BI." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Validate for Restore of Backup Instance", + "description": "Validates for Restore of the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/restore/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Restore Backup Instance", + "description": "Triggers restore on the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Create Backup Policy", + "description": "Creates Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Delete Backup Policy", + "description": "Deletes the Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Get Backup Policy details", + "description": "Returns details of the Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Get Backup Policies", + "description": "Returns all Backup Policies" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Get the list of ResourceGuard proxies for a resource", + "description": "Get the list of ResourceGuard proxies for a resource" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Get ResourceGuard proxy", + "description": "Get ResourceGuard proxy operation gets an object representing the Azure resource of type 'ResourceGuard proxy'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Create ResourceGuard proxy", + "description": "Create ResourceGuard proxy operation creates an Azure resource of type 'ResourceGuard Proxy'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Delete ResourceGuard proxy", + "description": "The Delete ResourceGuard proxy operation deletes the specified Azure resource of type 'ResourceGuard proxy'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/unlockDelete/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation", + "description": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Recovery Points", + "operation": "Get Recovery Point Details", + "description": "Returns details of the Recovery Point" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Returns all Recovery Points" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Restorable Time Ranges", + "operation": "Find Restorable Time Ranges", + "description": "Finds Restorable Time Ranges" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Operation Result of a Patch Operation for a Backup Vault", + "description": "Gets Operation Result of a Patch Operation for a Backup Vault" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/checkNameAvailability/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Check if the requested BackupVault Name is Available", + "description": "Checks if the requested BackupVault Name is Available" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Backup Vaults in a Resource Group", + "description": "Gets list of Backup Vaults in a Resource Group" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Backup Vaults in a Subscription", + "description": "Gets list of Backup Vaults in a Subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Create ResourceGuard", + "description": "Create ResourceGuard operation creates an Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard", + "description": "The Get ResourceGuard operation gets an object representing the Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Delete ResourceGuard", + "description": "The Delete ResourceGuard operation deletes the specified Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuards in a Resource Group", + "description": "Gets list of ResourceGuards in a Resource Group" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuards in a Subscription", + "description": "Gets list of ResourceGuards in a Subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Update ResourceGuard", + "description": "Update ResouceGuard operation updates an Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard operation request info", + "description": "Gets ResourceGuard operation request info" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard default operation request info", + "description": "Gets ResourceGuard default operation request info" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/providers/locations/checkFeatureSupport/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "Validate if a feature is supported", + "description": "Validates if a feature is supported" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/validateForBackup/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Validate Backup", + "operation": "Validate for backup of Backup Instance", + "description": "Validates for backup of Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupJobs/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Jobs", + "operation": "Backup Jobs", + "description": "Get Jobs list" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Jobs", + "operation": "Backup Job Object", + "description": "Get Job details" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/register/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "Register Resource Provider", + "description": "Registers subscription for given Resource Provider" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/unregister/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "Unregister Resource Provider", + "description": "Unregisters subscription for given Resource Provider" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/operations/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "List of Operations", + "description": "Operation returns the list of Operations for a Resource Provider" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json similarity index 99% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json index b04ffe956878..958008f1d9ce 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json @@ -4,7 +4,7 @@ "resourceGroupName": "000pikumar", "vaultName": "PrivatePreviewVault", "backupPolicyName": "OSSDBPolicy", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "properties": { "policyRules": [ diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/DeleteBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/DeleteBackupPolicy.json similarity index 88% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/DeleteBackupPolicy.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/DeleteBackupPolicy.json index 5e2a338b87c6..5e4208f35f9b 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/DeleteBackupPolicy.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/DeleteBackupPolicy.json @@ -4,7 +4,7 @@ "resourceGroupName": "000pikumar", "vaultName": "PrivatePreviewVault", "backupPolicyName": "OSSDBPolicy", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": {}, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/GetBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/GetBackupPolicy.json similarity index 99% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/GetBackupPolicy.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/GetBackupPolicy.json index 04e73916b26e..3788945e1732 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/GetBackupPolicy.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/GetBackupPolicy.json @@ -4,7 +4,7 @@ "resourceGroupName": "000pikumar", "vaultName": "PrivatePreviewVault", "backupPolicyName": "OSSDBPolicy", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/ListBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/ListBackupPolicy.json similarity index 99% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/ListBackupPolicy.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/ListBackupPolicy.json index 8cc22de63c19..c6fd9f9287fb 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/PolicyCRUD/ListBackupPolicy.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/PolicyCRUD/ListBackupPolicy.json @@ -3,7 +3,7 @@ "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", "resourceGroupName": "000pikumar", "vaultName": "PrivatePreviewVault", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json similarity index 87% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json index 966b1384ee94..6605e806d48b 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/DeleteResourceGuard.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": {}, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json similarity index 94% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json index 23e436a8eed4..28b2433001c5 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", "requestName": "default", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json similarity index 94% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json index b79db23b88ec..a6c7b94cca69 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", "requestName": "default", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json similarity index 94% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json index 7240d533d186..20fc4c4c43ea 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", "requestName": "default", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json similarity index 94% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json index 327a0b2c2c27..67751c5441c9 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", "requestName": "default", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json similarity index 94% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json index 9d97662da88e..9da6e019c3ca 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", "requestName": "default", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json similarity index 94% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json index 9b07a85091e3..6bdc8bd8934a 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", "requestName": "default", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetResourceGuard.json similarity index 97% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetResourceGuard.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetResourceGuard.json index 4a57af5090e4..92aeb47f5be5 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetResourceGuard.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetResourceGuard.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json similarity index 97% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json index 9d74772c8f2f..e06b7ac442f5 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json similarity index 97% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json index d8efb0c4ac82..51950f1c3c4b 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json @@ -1,7 +1,7 @@ { "parameters": { "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json similarity index 95% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json index f6b405dc69aa..da920c14ba31 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json similarity index 95% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json index 4d5702e7ae0e..cf2d3184a477 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json similarity index 95% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json index c9738b034e34..55940c374987 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json similarity index 95% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json index ca5bf6b538cb..46a9b9b147cd 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json similarity index 95% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json index eb2dca7d2d99..bb6617747fe1 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json similarity index 95% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json index cd1d54e6260c..0b53a41e7d5d 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/PatchResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/PatchResourceGuard.json similarity index 97% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/PatchResourceGuard.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/PatchResourceGuard.json index f0a83e37cb6c..e01a1049ee5b 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/PatchResourceGuard.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/PatchResourceGuard.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "tags": { "newKey": "newVal" diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/PutResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/PutResourceGuard.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/PutResourceGuard.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/PutResourceGuard.json index c43f3e7026d3..135733aad0d4 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardCRUD/PutResourceGuard.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardCRUD/PutResourceGuard.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "resourceGuardsName": "swaggerExample", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "location": "WestUS", "tags": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json similarity index 89% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json index ef2f97b64a41..5b20df8008a4 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json @@ -4,7 +4,7 @@ "vaultName": "sampleVault", "resourceGroupName": "SampleResourceGroup", "resourceGuardProxyName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": {}, diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json index 299ab5b43c29..eb1335701db7 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json @@ -4,7 +4,7 @@ "vaultName": "sampleVault", "resourceGroupName": "SampleResourceGroup", "resourceGuardProxyName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json index 9ac2c0294d04..de97f0524902 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json @@ -3,7 +3,7 @@ "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7", "vaultName": "sampleVault", "resourceGroupName": "SampleResourceGroup", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json index 507bd2fa8016..726f51273572 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json @@ -4,7 +4,7 @@ "vaultName": "sampleVault", "resourceGroupName": "SampleResourceGroup", "resourceGuardProxyName": "swaggerExample", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "properties": { "resourceGuardResourceId": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource" diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json similarity index 96% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json index 318c85163e03..4f5746445747 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json @@ -4,7 +4,7 @@ "vaultName": "sampleVault", "resourceGroupName": "SampleResourceGroup", "resourceGuardProxyName": "swaggerExample", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "resourceGuardOperationRequests": [ "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default" diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json similarity index 91% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json index d37e59cf8eb9..4e01c06c7002 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "location": "westus", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "type": "Microsoft.DataProtection/BackupVaults", "name": "swaggerExample" diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/DeleteBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/DeleteBackupVault.json similarity index 92% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/DeleteBackupVault.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/DeleteBackupVault.json index 28a691947661..771cc23f2945 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/DeleteBackupVault.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/DeleteBackupVault.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "vaultName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": {}, @@ -11,8 +11,8 @@ "202": { "headers": { "Retry-After": "10", - "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01", - "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01" + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01" } } } diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVault.json similarity index 97% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVault.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVault.json index 5e692cb367be..1b9088c3406f 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVault.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVault.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "vaultName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVaultWithMSI.json similarity index 97% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVaultWithMSI.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVaultWithMSI.json index 6aba51d9f337..351ce582b482 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVaultWithMSI.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVaultWithMSI.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "vaultName": "swaggerExample", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json index 1d11fa88b59e..22b2bab64251 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json index 3d87f533ae29..003947877a7e 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetBackupVaultsInSubscription.json @@ -1,7 +1,7 @@ { "parameters": { "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetOperationResultPatch.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetOperationResultPatch.json similarity index 93% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetOperationResultPatch.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetOperationResultPatch.json index 3ee8151b26a6..cfdbc4dbf699 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/GetOperationResultPatch.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/GetOperationResultPatch.json @@ -4,14 +4,14 @@ "resourceGroupName": "SampleResourceGroup", "vaultName": "swaggerExample", "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", - "api-version": "2023-08-01" + "api-version": "2023-11-01" }, "responses": { "200": { "headers": { "Retry-After": "10", - "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01", - "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01" + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01" }, "body": { "identity": { @@ -37,8 +37,8 @@ }, "202": { "headers": { - "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01", - "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01", "Retry-After": "60" } } diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/PatchBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/PatchBackupVault.json similarity index 95% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/PatchBackupVault.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/PatchBackupVault.json index 488704a7070d..b9b97783a362 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/PatchBackupVault.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/PatchBackupVault.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "vaultName": "swaggerExample", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", "parameters": { "tags": { @@ -22,8 +22,8 @@ "202": { "headers": { "Retry-After": "10", - "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01", - "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01" + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01" } }, "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/PutBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/PutBackupVault.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/PutBackupVault.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/PutBackupVault.json index 7f1bd975fc03..c161432929d6 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/PutBackupVault.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/PutBackupVault.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "vaultName": "swaggerExample", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "location": "WestUS", "tags": { @@ -77,7 +77,7 @@ }, "headers": { "Retry-After": "10", - "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01" + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01" } }, "200": { diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/PutBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/PutBackupVaultWithMSI.json similarity index 98% rename from specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/PutBackupVaultWithMSI.json rename to specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/PutBackupVaultWithMSI.json index 66ffd3c6268d..85d8ca8aa9de 100644 --- a/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-08-01/examples/VaultCRUD/PutBackupVaultWithMSI.json +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-11-01/examples/VaultCRUD/PutBackupVaultWithMSI.json @@ -3,7 +3,7 @@ "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", "resourceGroupName": "SampleResourceGroup", "vaultName": "swaggerExample", - "api-version": "2023-08-01", + "api-version": "2023-11-01", "parameters": { "location": "WestUS", "tags": { @@ -77,7 +77,7 @@ }, "headers": { "Retry-After": "10", - "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-08-01" + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-11-01" } }, "200": { diff --git a/specification/dataprotection/resource-manager/readme.md b/specification/dataprotection/resource-manager/readme.md index f71bb4db13bc..0178f7c1295a 100644 --- a/specification/dataprotection/resource-manager/readme.md +++ b/specification/dataprotection/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the DataProtection API. title: Data Protection Client description: Open API 2.0 Specs for Azure Data Protection service openapi-type: arm -tag: package-2023-08 +tag: package-2023-11 csharp-sdks-folder: ./Generated/CSharp python-sdks-folder: ./Generated/Python go-sdk-folder: ./Generated/Golang @@ -51,13 +51,13 @@ message-format: json ``` -### Tag: package-2023-08 +### Tag: package-2023-11 -These settings apply only when `--tag=package-2023-08` is specified on the command line. +These settings apply only when `--tag=package-2023-11` is specified on the command line. -```yaml $(tag) == 'package-2023-08' +```yaml $(tag) == 'package-2023-11' input-file: - - Microsoft.DataProtection/stable/2023-08-01/dataprotection.json + - Microsoft.DataProtection/stable/2023-11-01/dataprotection.json ``` ### Tag: package-preview-2023-08 @@ -298,3 +298,12 @@ See configuration in [readme.go.md](./readme.go.md) ## Java See configuration in [readme.java.md](./readme.java.md) + +## Suppression +``` yaml +directive: + - suppress: ParametersInPost + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchSecondaryRecoveryPoints"].post + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchCrossRegionRestoreJobs"].post +``` diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/desktopvirtualization.json new file mode 100644 index 000000000000..fadbb4bcf387 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/desktopvirtualization.json @@ -0,0 +1,10208 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-11-01-preview", + "title": "Desktop Virtualization API Client" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "host": "management.azure.com", + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.DesktopVirtualization/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List all of the available operations the Desktop Virtualization resource provider supports.", + "x-ms-examples": { + "OperationDescription_List": { + "$ref": "./examples/OperationDescription_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Get", + "description": "Get a workspace.", + "x-ms-examples": { + "Workspace_Get": { + "$ref": "./examples/Workspace_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_CreateOrUpdate", + "description": "Create or update a workspace.", + "x-ms-examples": { + "Workspace_Create": { + "$ref": "./examples/Workspace_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Successfully created workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Delete", + "description": "Remove a workspace.", + "x-ms-examples": { + "Workspace_Delete": { + "$ref": "./examples/Workspace_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted workspace." + }, + "204": { + "description": "Workspace does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_Update", + "description": "Update a workspace.", + "x-ms-examples": { + "Workspace_Update": { + "$ref": "./examples/Workspace_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "workspace", + "description": "Object containing Workspace definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/WorkspacePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated workspace.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_ListByWorkspace", + "description": "List private endpoint connections.", + "x-ms-examples": { + "PrivateEndpointConnection_ListByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_ListByWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved connection list.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_GetByWorkspace", + "description": "Get a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_GetByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_GetByWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_DeleteByWorkspace", + "description": "Remove a connection.", + "x-ms-examples": { + "PrivateEndpointConnection_DeleteByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_DeleteByWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully removed." + }, + "204": { + "description": "Connection does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_UpdateByWorkspace", + "description": "Approve or reject a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_UpdateByWorkspace": { + "$ref": "./examples/PrivateEndpointConnection_UpdateByWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "connection", + "description": "Object containing the updated connection.", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateLinkResources_ListByWorkspace", + "description": "List the private link resources available for this workspace.", + "x-ms-examples": { + "PrivateLinkResources_ListByWorkspace": { + "$ref": "./examples/PrivateLinkResources_ListByWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListByResourceGroup", + "description": "List workspaces.", + "x-ms-examples": { + "Workspace_ListByResourceGroup": { + "$ref": "./examples/Workspace_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in resource group.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "tags": [ + "Workspace" + ], + "operationId": "Workspaces_ListBySubscription", + "description": "List workspaces in subscription.", + "x-ms-examples": { + "Workspace_ListBySubscription": { + "$ref": "./examples/Workspace_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved workspaces in subscription.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Get", + "description": "Get a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Get": { + "$ref": "./examples/ScalingPlan_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Create", + "description": "Create or update a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Create": { + "$ref": "./examples/ScalingPlan_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "name": "scalingPlan", + "description": "Object containing scaling plan definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "201": { + "description": "Successfully created scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Delete", + "description": "Remove a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Delete": { + "$ref": "./examples/ScalingPlan_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted scaling plan." + }, + "204": { + "description": "Scaling plan does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_Update", + "description": "Update a scaling plan.", + "x-ms-examples": { + "ScalingPlans_Update": { + "$ref": "./examples/ScalingPlan_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "name": "scalingPlan", + "description": "Object containing scaling plan definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated scaling plan.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_ListByResourceGroup", + "description": "List scaling plans.", + "x-ms-examples": { + "ScalingPlans_ListByResourceGroup": { + "$ref": "./examples/ScalingPlan_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plans in resource group.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}": { + "get": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Get", + "description": "Get a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Get": { + "$ref": "./examples/ScalingPlanPooledSchedule_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Create", + "description": "Create or update a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Create": { + "$ref": "./examples/ScalingPlanPooledSchedule_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPooledSchedule definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "201": { + "description": "Successfully created ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Delete", + "description": "Remove a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Delete": { + "$ref": "./examples/ScalingPlanPooledSchedule_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed ScalingPlanPooledSchedule." + }, + "204": { + "description": "ScalingPlanPooledSchedule does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_Update", + "description": "Update a ScalingPlanPooledSchedule.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_Update": { + "$ref": "./examples/ScalingPlanPooledSchedule_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPooledSchedule definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedulePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPooledSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules": { + "get": { + "tags": [ + "ScalingPlanPooledSchedule" + ], + "operationId": "ScalingPlanPooledSchedules_List", + "description": "List ScalingPlanPooledSchedules.", + "x-ms-examples": { + "ScalingPlanPooledSchedules_List": { + "$ref": "./examples/ScalingPlanPooledSchedule_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPooledSchedules.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledScheduleList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}": { + "get": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Get", + "description": "Get a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Get": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Create", + "description": "Create or update a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Create": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPersonalSchedule definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "201": { + "description": "Successfully created ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Delete", + "description": "Remove a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Delete": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed ScalingPlanPersonalSchedule." + }, + "204": { + "description": "ScalingPlanPersonalSchedule does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_Update", + "description": "Update a ScalingPlanPersonalSchedule.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Update": { + "$ref": "./examples/ScalingPlanPersonalSchedule_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanScheduleNameParameter" + }, + { + "name": "scalingPlanSchedule", + "description": "Object containing ScalingPlanPersonalSchedule definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedulePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated ScalingPlanPersonalSchedule.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules": { + "get": { + "tags": [ + "ScalingPlanPersonalSchedule" + ], + "operationId": "ScalingPlanPersonalSchedules_List", + "description": "List ScalingPlanPersonalSchedules.", + "x-ms-examples": { + "ScalingPlanPersonalSchedules_List": { + "$ref": "./examples/ScalingPlanPersonalSchedule_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScalingPlanNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved ScalingPlanPersonalSchedules.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalScheduleList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_ListBySubscription", + "description": "List scaling plans in subscription.", + "x-ms-examples": { + "ScalingPlans_ListBySubscription": { + "$ref": "./examples/ScalingPlan_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plans in subscription.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Get", + "description": "Get an application group.", + "x-ms-examples": { + "ApplicationGroup_Get": { + "$ref": "./examples/ApplicationGroup_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_CreateOrUpdate", + "description": "Create or update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Create": { + "$ref": "./examples/ApplicationGroup_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "201": { + "description": "Successfully created application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Delete", + "description": "Remove an applicationGroup.", + "x-ms-examples": { + "ApplicationGroup_Delete": { + "$ref": "./examples/ApplicationGroup_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application group." + }, + "204": { + "description": "Application group does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_Update", + "description": "Update an applicationGroup.", + "x-ms-examples": { + "ApplicationGroups_Update": { + "$ref": "./examples/ApplicationGroup_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "applicationGroup", + "description": "Object containing ApplicationGroup definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationGroupPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application group.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListByResourceGroup", + "description": "List applicationGroups.", + "x-ms-examples": { + "ApplicationGroup_ListByResourceGroup": { + "$ref": "./examples/ApplicationGroup_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in resource group.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "tags": [ + "ApplicationGroup" + ], + "operationId": "ApplicationGroups_ListBySubscription", + "description": "List applicationGroups in subscription.", + "x-ms-examples": { + "ApplicationGroup_List": { + "$ref": "./examples/ApplicationGroup_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application groups in subscription.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { + "get": { + "tags": [ + "StartMenuItem" + ], + "operationId": "StartMenuItems_List", + "description": "List start menu items in the given application group.", + "x-ms-examples": { + "StartMenuItem_List": { + "$ref": "./examples/StartMenuItem_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved start menu items in application group.", + "schema": { + "$ref": "#/definitions/StartMenuItemList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "description": "Get an application.", + "x-ms-examples": { + "Application_Get": { + "$ref": "./examples/Application_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_CreateOrUpdate", + "description": "Create or update an application.", + "x-ms-examples": { + "Application_Create": { + "$ref": "./examples/Application_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "201": { + "description": "Successfully created application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "description": "Remove an application.", + "x-ms-examples": { + "Application_Delete": { + "$ref": "./examples/Application_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed application." + }, + "204": { + "description": "Application does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "description": "Update an application.", + "x-ms-examples": { + "Application_Update": { + "$ref": "./examples/Application_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "application", + "description": "Object containing Application definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated application.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "description": "List applications.", + "x-ms-examples": { + "Applications_List": { + "$ref": "./examples/Application_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved applications in application group.", + "schema": { + "$ref": "#/definitions/ApplicationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Get", + "description": "Get a desktop.", + "x-ms-examples": { + "Desktop_Get": { + "$ref": "./examples/Desktop_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_Update", + "description": "Update a desktop.", + "x-ms-examples": { + "Desktop_Update": { + "$ref": "./examples/Desktop_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "$ref": "#/parameters/DesktopNameParameter" + }, + { + "name": "desktop", + "description": "Object containing Desktop definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DesktopPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated desktop.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { + "get": { + "tags": [ + "Desktop" + ], + "operationId": "Desktops_List", + "description": "List desktops.", + "x-ms-examples": { + "Desktop_List": { + "$ref": "./examples/Desktop_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApplicationGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved desktops in application group.", + "schema": { + "$ref": "#/definitions/DesktopList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Get", + "description": "Get a host pool.", + "x-ms-examples": { + "HostPool_Get": { + "$ref": "./examples/HostPool_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_CreateOrUpdate", + "description": "Create or update a host pool.", + "x-ms-examples": { + "HostPool_Create": { + "$ref": "./examples/HostPool_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPool" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "201": { + "description": "Successfully created host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Delete", + "description": "Remove a host pool.", + "x-ms-examples": { + "HostPool_Delete": { + "$ref": "./examples/HostPool_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to delete sessionHost." + } + ], + "responses": { + "200": { + "description": "Successfully removed host pool." + }, + "204": { + "description": "Host pool does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_Update", + "description": "Update a host pool.", + "x-ms-examples": { + "HostPool_Update": { + "$ref": "./examples/HostPool_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPool", + "description": "Object containing HostPool definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/HostPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated host pool.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_ListByResourceGroup", + "description": "List hostPools.", + "x-ms-examples": { + "HostPool_ListByResourceGroup": { + "$ref": "./examples/HostPool_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_List", + "description": "List hostPools in subscription.", + "x-ms-examples": { + "HostPool_List": { + "$ref": "./examples/HostPool_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in subscription.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default": { + "get": { + "tags": [ + "SessionHostManagements" + ], + "operationId": "SessionHostManagements_Get", + "description": "Get a SessionHostManagement.", + "x-ms-examples": { + "SessionHostManagements_Get": { + "$ref": "./examples/SessionHostManagements_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved sessionHostManagement.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "SessionHostManagements_CreateOrUpdate", + "description": "Create or update a SessionHostManagement.", + "x-ms-examples": { + "SessionHostManagements_Create": { + "$ref": "./examples/SessionHostManagements_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "sessionHostManagement", + "description": "Object containing SessionHostManagement definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated SessionHostManagement.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "201": { + "description": "Successfully created SessionHostManagement.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "SessionHostManagements_Update", + "description": "Update a SessionHostManagement.", + "x-ms-examples": { + "SessionHostManagements_Update": { + "$ref": "./examples/SessionHostManagements_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "sessionHostManagement", + "description": "Object containing SessionHostManagement definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostManagementPatch" + } + } + ], + "responses": { + "200": { + "description": "Update SessionHostManagement success.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements": { + "get": { + "tags": [ + "SessionHostManagements" + ], + "operationId": "SessionHostManagements_ListByHostPool", + "description": "List SessionHostManagements by hostPool.", + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/SessionHostManagements_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved SessionHostManagements in HostPool.", + "schema": { + "$ref": "#/definitions/SessionHostManagementList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/validateSessionHostUpdate": { + "post": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "ValidateSessionHostUpdate_Post", + "description": "Validates a session host update operation for validation errors. When Session Host Configuration and Session Host Management values are not provided the ones saved in the Host Pool will be used.", + "x-ms-examples": { + "HostPools_Update_Post": { + "$ref": "./examples/SessionHostManagements_ValidateSessionHostUpdate_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "validateSessionHostUpdateRequestBody", + "description": "Object containing the definition for properties to be used in the sessionHostUpdate validation.", + "in": "body", + "schema": { + "$ref": "#/definitions/ValidateSessionHostUpdateRequestBody" + } + } + ], + "responses": { + "202": { + "description": "Successfully initiated hostpool update.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/initiateSessionHostUpdate": { + "post": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "InitiateSessionHostUpdate_Post", + "description": "Initiates a hostpool update or schedule an update for the future.", + "x-ms-examples": { + "HostPools_Update_Post": { + "$ref": "./examples/SessionHostManagements_UpdateSessionHosts_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "updateSessionHostsRequestBody", + "description": "Object containing the definition for properties to be used in the sessionHostUpdate validation.", + "in": "body", + "schema": { + "$ref": "#/definitions/UpdateSessionHostsRequestBody" + } + } + ], + "responses": { + "202": { + "description": "Successfully initiated hostpool update.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostUpdate": { + "post": { + "tags": [ + "SessionHostManagement" + ], + "operationId": "ControlSessionHostUpdate_Post", + "description": "Control update of a hostpool.", + "x-ms-examples": { + "SessionHostManagements_ControlUpdate_Post": { + "$ref": "./examples/SessionHostManagements_ControlSessionHostUpdate_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "hostPoolControlParameter", + "description": "Object containing control action for hostpool update.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HostPoolControlParameter" + } + } + ], + "responses": { + "202": { + "description": "Successfully controlled hostpool update.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/operationStatuses/{operationId}": { + "get": { + "tags": [ + "SessionHostManagements" + ], + "operationId": "SessionHostManagementsOperationStatus_Get", + "description": "Get Operation status for SessionHostManagement", + "x-ms-examples": { + "SessionHostManagementsOperationStatus_Get": { + "$ref": "./examples/SessionHostManagementsOperationStatus_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operation status.", + "schema": { + "$ref": "#/definitions/SessionHostManagementOperationStatus" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/operationStatuses": { + "get": { + "tags": [ + "SessionHostManagements" + ], + "operationId": "SessionHostManagementsOperationStatus_List", + "description": "Get Operation status for SessionHostManagement", + "x-ms-examples": { + "SessionHostManagementsOperationStatus_List": { + "$ref": "./examples/SessionHostManagementsOperationStatus_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "isLatest", + "in": "query", + "required": false, + "type": "boolean", + "description": "Returns the most recent sessionHostManagement operation." + }, + { + "name": "type", + "in": "query", + "required": false, + "type": "string", + "description": "Filter based on the type of sessionHostManagement operation. Valid values are 'InitiateSessionHostUpdate' and 'ValidateSessionHostUpdate'" + }, + { + "name": "isNonTerminal", + "in": "query", + "required": false, + "type": "boolean", + "description": "Returns currently running operations. Ignored if 'isLatest' is true" + }, + { + "name": "correlationId", + "in": "query", + "required": false, + "type": "string", + "description": "CorrelationId of the sessionHostManagement operations to be returned." + }, + { + "name": "action", + "in": "query", + "required": false, + "type": "string", + "description": "Action type for the Operation Status list to be filtered on. Valid actions are: start | retry | pause | resume | cancel)." + }, + { + "name": "isInitiatingOperation", + "in": "query", + "required": false, + "type": "boolean", + "description": "Filter option to only return operations that initiated a sessionHostManagement operation." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operation status.", + "schema": { + "$ref": "#/definitions/SessionHostManagementOperationStatusList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default": { + "put": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_CreateOrUpdate", + "description": "Create or update a SessionHostConfiguration.", + "x-ms-examples": { + "SessionHostConfigurations_Create": { + "$ref": "./examples/SessionHostConfigurations_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "sessionHostConfiguration", + "description": "Object containing SessionHostConfiguration definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successfully initiated SessionHostConfiguration Update validation.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "201": { + "description": "Successfully created Session Host Configuration.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_Update", + "description": "Update a SessionHostConfiguration.", + "x-ms-examples": { + "SessionHostConfigurations_Update": { + "$ref": "./examples/SessionHostConfigurations_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "sessionHostConfiguration", + "description": "Object containing SessionHostConfiguration definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostConfigurationPatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully created SessionHostConfiguration.", + "headers": { + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "202": { + "description": "Successfully created SessionHostConfiguration.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_Get", + "description": "Get a SessionHostConfiguration.", + "x-ms-examples": { + "SessionHostConfigurations_Get": { + "$ref": "./examples/SessionHostConfigurations_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved sessionHostConfiguration.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations": { + "get": { + "tags": [ + "SessionHostConfiguration" + ], + "operationId": "SessionHostConfigurations_ListByHostPool", + "description": "List sessionHostConfigurations.", + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/SessionHostConfigurations_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved sessionHostConfigurations in HostPool.", + "schema": { + "$ref": "#/definitions/SessionHostConfigurationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default/operationStatuses/{operationId}": { + "get": { + "tags": [ + "SessionHostConfigurations" + ], + "operationId": "SessionHostConfigurationsOperationStatus_Get", + "description": "Get Operation status for SessionHostManagement", + "x-ms-examples": { + "SessionHostConfigurationsOperationStatus_Get": { + "$ref": "./examples/SessionHostConfigurationsOperationStatus_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operation status.", + "schema": { + "$ref": "#/definitions/SessionHostConfigurationOperationStatus" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default/operationStatuses": { + "get": { + "tags": [ + "SessionHostConfigurations" + ], + "operationId": "SessionHostConfigurationsOperationStatus_List", + "description": "Get Operation status for SessionHostConfiguration", + "x-ms-examples": { + "SessionHostConfigurationsOperationStatus_List": { + "$ref": "./examples/SessionHostConfigurationsOperationStatus_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "isLatest", + "in": "query", + "required": false, + "type": "boolean", + "description": "Returns the most recent sessionHostConfiguration operation." + }, + { + "name": "isNonTerminal", + "in": "query", + "required": false, + "type": "boolean", + "description": "Returns currently running operations. Ignored if 'isLatest' is true" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operation status.", + "schema": { + "$ref": "#/definitions/SessionHostConfigurationOperationStatusList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations/default": { + "get": { + "tags": [ + "ActiveSessionHostConfiguration" + ], + "operationId": "ActiveSessionHostConfigurations_Get", + "description": "Get the ActiveSessionHostConfiguration for the hostPool that is currently being used for update operations.", + "x-ms-examples": { + "SessionHostConfigurations_Get": { + "$ref": "./examples/ActiveSessionHostConfigurations_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved activeSessionHostConfiguration.", + "schema": { + "$ref": "#/definitions/ActiveSessionHostConfiguration" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations": { + "get": { + "tags": [ + "ActiveSessionHostConfiguration" + ], + "operationId": "ActiveSessionHostConfigurations_ListByHostPool", + "description": "List activeSessionHostConfigurations.", + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/ActiveSessionHostConfigurations_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved activeSessionHostConfigurations in HostPool.", + "schema": { + "$ref": "#/definitions/ActiveSessionHostConfigurationList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateLinkResources_ListByHostPool", + "description": "List the private link resources available for this hostpool.", + "x-ms-examples": { + "PrivateLinkResources_ListByHostPool": { + "$ref": "./examples/PrivateLinkResources_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/retrieveRegistrationToken": { + "post": { + "tags": [ + "HostPool" + ], + "operationId": "HostPools_RetrieveRegistrationToken", + "description": "Registration token of the host pool.", + "x-ms-examples": { + "HostPools_RetrieveRegistrationToken_Post": { + "$ref": "./examples/HostPools_RetrieveRegistrationToken_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved host pool in resource group.", + "schema": { + "$ref": "#/definitions/RegistrationInfo" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_ListByHostPool", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_ListByHostPool": { + "$ref": "./examples/UserSession_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in host pool.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Get", + "description": "Get a session host.", + "x-ms-examples": { + "SessionHost_Get": { + "$ref": "./examples/SessionHost_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Delete", + "description": "Remove a SessionHost.", + "x-ms-examples": { + "SessionHost_Delete": { + "$ref": "./examples/SessionHost_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to force sessionHost deletion even when userSession exists." + } + ], + "responses": { + "200": { + "description": "Successfully removed session host." + }, + "204": { + "description": "Session host does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_Update", + "description": "Update a session host.", + "x-ms-examples": { + "SessionHost_Update": { + "$ref": "./examples/SessionHost_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "sessionHost", + "description": "Object containing SessionHost definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostPatch" + } + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to update assign, unassign or reassign personal desktop." + } + ], + "responses": { + "200": { + "description": "Successfully updated session host.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { + "get": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHosts_List", + "description": "List sessionHosts.", + "x-ms-examples": { + "SessionHost_List": { + "$ref": "./examples/SessionHost_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved session hosts in host pool.", + "schema": { + "$ref": "#/definitions/SessionHostList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/retryProvisioning": { + "post": { + "tags": [ + "SessionHost" + ], + "operationId": "SessionHost_RetryProvisioning", + "description": "Retry provisioning on a SessionHost.", + "x-ms-examples": { + "SessionHost_RetryProvisioning_Post": { + "$ref": "./examples/SessionHost_RetryProvisioning_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully started provisioning retry on the sessionHost." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}": { + "get": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_Get", + "description": "Get a msixpackage.", + "x-ms-examples": { + "MSIXPackage_Get": { + "$ref": "./examples/MsixPackage_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_CreateOrUpdate", + "description": "Create or update a MSIX package.", + "x-ms-examples": { + "MSIXPackage_Create": { + "$ref": "./examples/MsixPackage_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + }, + { + "name": "msixPackage", + "description": "Object containing MSIX Package definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "201": { + "description": "Successfully created MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_Delete", + "description": "Remove an MSIX Package.", + "x-ms-examples": { + "MSIXPackage_Delete": { + "$ref": "./examples/MsixPackage_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed MSIX Package." + }, + "204": { + "description": "MSIX Package does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_Update", + "description": "Update an MSIX Package.", + "x-ms-examples": { + "MSIXPackage_Update": { + "$ref": "./examples/MsixPackage_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/MSIXPackageFullNameParameter" + }, + { + "name": "msixPackage", + "description": "Object containing MSIX Package definitions.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/MSIXPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated MSIX Package.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages": { + "get": { + "tags": [ + "MSIXPackage" + ], + "operationId": "MSIXPackages_List", + "description": "List MSIX packages in hostpool.", + "x-ms-examples": { + "MSIXPackage_List": { + "$ref": "./examples/MsixPackage_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved MSIX Packages in hostpool.", + "schema": { + "$ref": "#/definitions/MSIXPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/importAppAttachPackageInfo": { + "post": { + "tags": [ + "AppAttachPackageInfo" + ], + "operationId": "AppAttachPackageInfo_Import", + "description": "Gets information from a package given the path to the package.", + "x-ms-examples": { + "AppAttachPackageInfo_Import": { + "$ref": "./examples/AppAttachPackageInfo_Import_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "importPackageInfoRequest", + "description": "Object containing URI to package image and other optional properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportPackageInfoRequest" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved packages in specified Image Path.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/expandMsixImage": { + "post": { + "tags": [ + "MsixImage" + ], + "operationId": "MsixImages_Expand", + "description": "Expands and Lists MSIX packages in an Image, given the Image Path.", + "x-ms-examples": { + "MsixImage_Expand": { + "$ref": "./examples/MsixImage_Expand_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "msixImageURI", + "description": "Object containing URI to MSIX Image", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXImageURI" + } + } + ], + "responses": { + "200": { + "description": "Successfully retrieved MSIX packages in specified Image Path.", + "schema": { + "$ref": "#/definitions/ExpandMsixImageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Get", + "description": "Get an app attach package.", + "x-ms-examples": { + "AppAttachPackage_Get": { + "$ref": "./examples/AppAttachPackage_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_CreateOrUpdate", + "description": "Create or update an App Attach package.", + "x-ms-examples": { + "AppAttachPackage_Create": { + "$ref": "./examples/AppAttachPackage_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "appAttachPackage", + "description": "Object containing App Attach Package definitions.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "201": { + "description": "Successfully created App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Delete", + "description": "Remove an App Attach Package.", + "x-ms-examples": { + "AppAttachPackage_Delete": { + "$ref": "./examples/AppAttachPackage_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to delete App Attach package." + } + ], + "responses": { + "200": { + "description": "Successfully deleted App Attach Package." + }, + "204": { + "description": "App Attach Package does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_Update", + "description": "Update an App Attach Package", + "x-ms-examples": { + "AppAttachPackage_Update": { + "$ref": "./examples/AppAttachPackage_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AppAttachPackageNameParameter" + }, + { + "name": "appAttachPackagePatch", + "description": "Object containing App Attach Package definition.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AppAttachPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated App Attach Package.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_ListByResourceGroup", + "description": "List App Attach packages in resource group.", + "x-ms-examples": { + "AppAttachPackage_ListByResourceGroup": { + "$ref": "./examples/AppAttachPackage_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are package name and host pool." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Packages in resource group.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "tags": [ + "AppAttachPackage" + ], + "operationId": "AppAttachPackage_ListBySubscription", + "description": "List App Attach packages in subscription.", + "x-ms-examples": { + "AppAttachPackage_ListBySubscription": { + "$ref": "./examples/AppAttachPackage_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are package name, host pool, and resource group." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved App Attach Packages in subscription.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Get", + "description": "Get a userSession.", + "x-ms-examples": { + "UserSession_Get": { + "$ref": "./examples/UserSession_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user session.", + "schema": { + "$ref": "#/definitions/UserSession" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Delete", + "description": "Remove a userSession.", + "x-ms-examples": { + "UserSession_Delete": { + "$ref": "./examples/UserSession_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Force flag to login off userSession." + } + ], + "responses": { + "200": { + "description": "Successfully removed user session." + }, + "204": { + "description": "User session does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { + "get": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_List", + "description": "List userSessions.", + "x-ms-examples": { + "UserSession_List": { + "$ref": "./examples/UserSession_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved user sessions in session host.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_Disconnect", + "description": "Disconnect a userSession.", + "x-ms-examples": { + "UserSession_Disconnect_Post": { + "$ref": "./examples/UserSession_Disconnect_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully disconnected user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { + "post": { + "tags": [ + "UserSession" + ], + "operationId": "UserSessions_SendMessage", + "description": "Send a message to a user.", + "x-ms-examples": { + "UserSession_SendMessage_Post": { + "$ref": "./examples/UserSession_SendMessage_Post.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "#/parameters/SessionHostNameParameter" + }, + { + "$ref": "#/parameters/UserSessionIdParameter" + }, + { + "name": "sendMessage", + "description": "Object containing message includes title and message body", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/SendMessage" + } + } + ], + "responses": { + "200": { + "description": "Successfully sent message to user session." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/scalingPlans": { + "get": { + "tags": [ + "ScalingPlan" + ], + "operationId": "ScalingPlans_ListByHostPool", + "description": "List scaling plan associated with hostpool.", + "x-ms-examples": { + "ScalingPlan_ListByHostPool": { + "$ref": "./examples/ScalingPlan_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved scaling plan associated with hostpool.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_ListByHostPool", + "description": "List private endpoint connections associated with hostpool.", + "x-ms-examples": { + "PrivateEndpointConnection_ListByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_ListByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of items per page." + }, + { + "name": "isDescending", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates whether the collection is descending." + }, + { + "name": "initialSkip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Initial number of items to skip." + } + ], + "responses": { + "200": { + "description": "Successfully retrieved connection list.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_GetByHostPool", + "description": "Get a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_GetByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_GetByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_DeleteByHostPool", + "description": "Remove a connection.", + "x-ms-examples": { + "PrivateEndpointConnection_DeleteByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_DeleteByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Successfully removed." + }, + "204": { + "description": "Connection does not exist." + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "PrivateLink" + ], + "operationId": "PrivateEndpointConnections_UpdateByHostPool", + "description": "Approve or reject a private endpoint connection.", + "x-ms-examples": { + "PrivateEndpointConnection_UpdateByHostPool": { + "$ref": "./examples/PrivateEndpointConnection_UpdateByHostPool.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HostPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "connection", + "description": "Object containing the updated connection.", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "Automation error response describing why the operation failed.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CloudError": { + "description": "Cloud error object.", + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorProperties" + } + } + }, + "CloudErrorProperties": { + "description": "Cloud error object properties.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "ResourceProviderOperationList": { + "type": "object", + "description": "Result of the request to list operations.", + "readOnly": true, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperation" + }, + "description": "List of operations supported by this resource provider." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ResourceProviderOperation": { + "type": "object", + "description": "Supported operation of this resource provider.", + "readOnly": true, + "properties": { + "name": { + "description": "Operation name, in format of {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "type": "object", + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Resource provider: Microsoft Desktop Virtualization.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of this operation.", + "type": "string" + } + } + }, + "isDataAction": { + "description": "Is a data action.", + "type": "boolean" + }, + "properties": { + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of the operation", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "ServiceSpecification": { + "description": "Service specification payload", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Specifications of the Log for Azure Monitoring", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "LogSpecification": { + "description": "Specifications of the Log for Azure Monitoring", + "type": "object", + "properties": { + "name": { + "description": "Name of the log", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log", + "type": "string" + }, + "blobDuration": { + "description": "Blob duration of the log", + "type": "string" + } + } + }, + "Workspace": { + "type": "object", + "description": "Represents a Workspace definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspaceProperties" + } + } + }, + "WorkspaceProperties": { + "description": "Schema for Workspace properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Workspace. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup resource Ids.", + "items": { + "type": "string" + } + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints", + "x-nullable": false + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified resource" + } + } + }, + "WorkspaceList": { + "type": "object", + "title": "WorkspaceList", + "description": "List of Workspace definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Workspace definitions.", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "WorkspacePatch": { + "type": "object", + "description": "Workspace properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkspacePatchProperties" + } + } + }, + "WorkspacePatchProperties": { + "description": "Workspace properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled to allow this resource to be access from the public network" + } + } + }, + "ApplicationGroup": { + "type": "object", + "description": "Represents a ApplicationGroup definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for ApplicationGroup", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupProperties", + "x-nullable": false + } + } + }, + "ApplicationGroupProperties": { + "description": "Schema for ApplicationGroup properties.", + "type": "object", + "required": [ + "hostPoolArmPath", + "applicationGroupType" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of ApplicationGroup. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "hostPoolArmPath": { + "type": "string", + "description": "HostPool arm path of ApplicationGroup.", + "x-nullable": false + }, + "workspaceArmPath": { + "type": "string", + "description": "Workspace arm path of ApplicationGroup.", + "readOnly": true + }, + "applicationGroupType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationGroupType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of ApplicationGroup.", + "x-nullable": false + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "showInFeed": { + "type": "boolean", + "description": "Boolean representing whether the applicationGroup is show in the feed." + } + } + }, + "ApplicationGroupPatch": { + "type": "object", + "description": "ApplicationGroup properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "ApplicationGroup properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGroupPatchProperties" + } + } + }, + "ApplicationGroupPatchProperties": { + "description": "ApplicationGroup properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "showInFeed": { + "type": "boolean", + "description": "Boolean representing whether the applicationGroup is show in the feed." + } + } + }, + "ApplicationGroupList": { + "type": "object", + "title": "ApplicationGroupList", + "description": "List of ApplicationGroup definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ApplicationGroup definitions.", + "items": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "HostPool": { + "type": "object", + "description": "Represents a HostPool definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for HostPool", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolProperties", + "x-nullable": false + } + } + }, + "HostPoolProperties": { + "description": "Properties of HostPool.", + "type": "object", + "required": [ + "hostPoolType", + "loadBalancerType", + "preferredAppGroupType" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of HostPool. (internal use)", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "hostPoolType": { + "enum": [ + "Personal", + "Pooled", + "BYODesktop" + ], + "x-ms-enum": { + "name": "HostPoolType", + "modelAsString": true, + "values": [ + { + "value": "Personal", + "description": "Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost." + }, + { + "value": "Pooled", + "description": "Users get a new (random) SessionHost every time it connects to the HostPool." + }, + { + "value": "BYODesktop", + "description": "Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct." + } + ] + }, + "type": "string", + "description": "HostPool type for desktop.", + "x-nullable": false + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "format": "int32", + "description": "The max session limit of HostPool." + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer.", + "x-nullable": false + }, + "ring": { + "type": "integer", + "format": "int32", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfo", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "managementType": { + "enum": [ + "Automated", + "Standard" + ], + "x-ms-enum": { + "name": "ManagementType", + "modelAsString": true + }, + "type": "string", + "description": "The type of management for this hostpool, Automated or Standard. The default value is Automated.", + "x-nullable": false + }, + "applicationGroupReferences": { + "readOnly": true, + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + }, + "appAttachPackageReferences": { + "readOnly": true, + "type": "array", + "description": "List of App Attach Package links.", + "items": { + "type": "string" + } + }, + "ssoadfsAuthority": { + "type": "string", + "description": "URL to customer ADFS server for signing WVD SSO certificates." + }, + "ssoClientId": { + "type": "string", + "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates." + }, + "ssoClientSecretKeyVaultPath": { + "type": "string", + "description": "Path to Azure KeyVault storing the secret used for communication to ADFS." + }, + "ssoSecretType": { + "enum": [ + "SharedKey", + "Certificate", + "SharedKeyInKeyVault", + "CertificateInKeyVault" + ], + "x-ms-enum": { + "name": "SSOSecretType", + "modelAsString": true + }, + "type": "string", + "description": "The type of single sign on Secret Type." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "x-nullable": false + }, + "startVMOnConnect": { + "type": "boolean", + "description": "The flag to turn on/off StartVMOnConnect feature." + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled", + "EnabledForSessionHostsOnly", + "EnabledForClientsOnly" + ], + "x-ms-enum": { + "name": "HostpoolPublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints", + "x-nullable": false + }, + "agentUpdate": { + "$ref": "#/definitions/AgentUpdateProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified resource" + } + } + }, + "HostPoolPatch": { + "type": "object", + "description": "HostPool properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "HostPool properties that can be patched.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HostPoolPatchProperties" + } + } + }, + "HostPoolPatchProperties": { + "description": "Properties of HostPool.", + "type": "object", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "format": "int32", + "description": "The max session limit of HostPool." + }, + "personalDesktopAssignmentType": { + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true + }, + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "loadBalancerType": { + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true + }, + "type": "string", + "description": "The type of the load balancer." + }, + "ring": { + "type": "integer", + "format": "int32", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfoPatch", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "ssoadfsAuthority": { + "type": "string", + "description": "URL to customer ADFS server for signing WVD SSO certificates." + }, + "ssoClientId": { + "type": "string", + "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates." + }, + "ssoClientSecretKeyVaultPath": { + "type": "string", + "description": "Path to Azure KeyVault storing the secret used for communication to ADFS." + }, + "ssoSecretType": { + "enum": [ + "SharedKey", + "Certificate", + "SharedKeyInKeyVault", + "CertificateInKeyVault" + ], + "x-ms-enum": { + "name": "SSOSecretType", + "modelAsString": true + }, + "type": "string", + "description": "The type of single sign on Secret Type." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group" + }, + "startVMOnConnect": { + "type": "boolean", + "description": "The flag to turn on/off StartVMOnConnect feature." + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled", + "EnabledForSessionHostsOnly", + "EnabledForClientsOnly" + ], + "x-ms-enum": { + "name": "HostpoolPublicNetworkAccess", + "modelAsString": true + }, + "type": "string", + "description": "Enabled to allow this resource to be access from the public network" + }, + "agentUpdate": { + "$ref": "#/definitions/AgentUpdatePatchProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + } + } + }, + "SessionHostManagementList": { + "type": "object", + "title": "SessionHostManagementList", + "description": "List of SessionHostManagement definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHostManagement definitions.", + "items": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHostManagement": { + "type": "object", + "description": "Represents a SessionHostManagement definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for SessionHostManagement", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostManagementProperties" + } + } + }, + "SessionHostManagementProperties": { + "description": "Session host Managements of HostPool.", + "type": "object", + "required": [ + "scheduledDateTimeZone", + "update" + ], + "properties": { + "scheduledDateTimeZone": { + "type": "string", + "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationProperties", + "description": "Parameters for a hostpool update." + } + } + }, + "SessionHostManagementPatch": { + "type": "object", + "description": "Represents a SessionHostManagementPatch definition.", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for SessionHostManagementPatch", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostManagementPatchProperties" + } + } + }, + "SessionHostManagementPatchProperties": { + "description": "Session host Managements of HostPool.", + "type": "object", + "properties": { + "scheduledDateTimeZone": { + "type": "string", + "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationPatchProperties", + "description": "Parameters for a hostpool update." + } + } + }, + "HostPoolUpdateConfigurationProperties": { + "description": "The configurations of a hostpool update.", + "type": "object", + "required": [ + "maxVmsRemoved", + "logOffDelayMinutes" + ], + "properties": { + "deleteOriginalVm": { + "type": "boolean", + "description": "Whether not to save original disk. False by default." + }, + "maxVmsRemoved": { + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual machines to be removed during hostpool update.", + "minimum": 1 + }, + "logOffDelayMinutes": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in minutes." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff. Default value is an empty string.", + "maxLength": 260, + "default": "" + } + } + }, + "HostPoolUpdateConfigurationPatchProperties": { + "description": "The configurations of a hostpool update.", + "type": "object", + "properties": { + "deleteOriginalVm": { + "type": "boolean", + "description": "Whether not to save original disk. False by default." + }, + "maxVmsRemoved": { + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual machines to be removed during hostpool update.", + "minimum": 1 + }, + "logOffDelayMinutes": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in minutes." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff.", + "maxLength": 260 + } + } + }, + "HostPoolControlParameter": { + "description": "Represents properties for a hostpool update.", + "type": "object", + "required": [ + "action" + ], + "properties": { + "action": { + "enum": [ + "Start", + "Pause", + "Cancel", + "Retry", + "Resume" + ], + "x-ms-enum": { + "name": "HostPoolUpdateAction", + "modelAsString": true, + "values": [ + { + "value": "Start", + "description": "Start the hostpool update." + }, + { + "value": "Pause", + "description": "Pause the hostpool update." + }, + { + "value": "Cancel", + "description": "Cancel the hostpool update." + }, + { + "value": "Retry", + "description": "Retry the hostpool update." + }, + { + "value": "Resume", + "description": "Resume the hostpool update." + } + ] + }, + "type": "string", + "description": "Action types for controlling hostpool update.", + "x-nullable": false + }, + "cancelMessage": { + "type": "string", + "description": "The cancel message sent to the user on the session host. This is can only be specified if the action is 'Cancel'.", + "maxLength": 260 + } + } + }, + "HostPoolUpdateFault": { + "description": "Hostpool update fault information.", + "type": "object", + "properties": { + "faultType": { + "type": "string", + "description": "Hostpool update fault type.", + "enum": [ + "ServiceError", + "UserError" + ], + "x-ms-enum": { + "name": "faultType", + "modelAsString": true, + "values": [ + { + "value": "ServiceError", + "description": "Fault caused by service error." + }, + { + "value": "UserError", + "description": "Fault caused by user error." + } + ] + } + }, + "faultCode": { + "type": "string", + "description": "Hostpool update fault code." + }, + "faultText": { + "type": "string", + "description": "Hostpool update fault text." + }, + "faultContext": { + "type": "string", + "description": "Hostpool update fault context." + } + } + }, + "SessionHostManagementOperationStatusList": { + "type": "object", + "title": "SessionHostManagementOperationStatusList", + "description": "List of SessionHostManagementOperationStatus definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHostManagementOperationStatus definitions.", + "items": { + "$ref": "#/definitions/SessionHostManagementOperationStatus" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHostManagementOperationStatus": { + "description": "The current status of an async operation.", + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string" + }, + "name": { + "description": "Name of the async operation.", + "type": "string" + }, + "status": { + "description": "Operation status. Current defined values are < Scheduled | UpdatingSessionHosts | ValidatingSessionHostUpdate | Paused | Pausing | Cancelling | Resuming | Starting > | Succeeded | Failed | Canceled", + "type": "string" + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time" + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionHostManagementOperationStatus" + } + }, + "error": { + "description": "If present, details of the operation error.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The custom properties of the OperationStatus.", + "$ref": "#/definitions/SessionHostManagementOperationStatusProperties" + } + } + }, + "SessionHostManagementOperationStatusProperties": { + "description": "Properties bag to hold custom RP properties for sessionHostManagement Operation Statuses.", + "type": "object", + "properties": { + "correlationId": { + "type": "string", + "description": "The Log Analytics." + }, + "type": { + "description": "Type of sessionHostManagement operation.", + "$ref": "#/definitions/SessionHostManagementOperationType" + }, + "action": { + "description": "Action type of the current sessionHostManagement operation.", + "enum": [ + "Start", + "Retry", + "Pause", + "Resume", + "Cancel" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationActionSHM", + "modelAsString": true + } + }, + "progress": { + "description": "Progress information on the sessionHostManagement operation.", + "$ref": "#/definitions/SessionHostManagementOperationProgress" + }, + "scheduledDateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp that the update is scheduled for." + }, + "sessionHostManagement": { + "description": "SessionHostManagement properties used for the operation.", + "$ref": "#/definitions/SessionHostManagement" + }, + "parentId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the operation that started this process." + } + } + }, + "SessionHostManagementOperationType": { + "enum": [ + "InitiateSessionHostUpdate", + "ValidateSessionHostUpdate" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationTypeSHM", + "modelAsString": true + } + }, + "SessionHostManagementOperationProgress": { + "type": "object", + "description": "SessionHostManagement Operation Progress information.", + "properties": { + "executionStartTime": { + "format": "date-time", + "type": "string", + "description": "Time that the sessionHostManagement operation was created." + }, + "totalSessionHosts": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts to be started in the sessionHostManagement operation." + }, + "sessionHostsInProgress": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts in progress in the sessionHostManagement operation." + }, + "sessionHostsCompleted": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts completed in the sessionHostManagement operation." + }, + "sessionHostsRollbackFailed": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts rollback failed in the sessionHostManagement operation." + } + } + }, + "SessionHostManagementProgressError": { + "description": "SessionHostManagement operation fault information.", + "type": "object", + "properties": { + "faultType": { + "type": "string", + "description": "SessionHostManagement operation fault type.", + "enum": [ + "ServiceError", + "UserError" + ], + "x-ms-enum": { + "name": "faultType", + "modelAsString": true, + "values": [ + { + "value": "ServiceError", + "description": "Fault caused by service error." + }, + { + "value": "UserError", + "description": "Fault caused by user error." + } + ] + } + }, + "faultCode": { + "type": "string", + "description": "SessionHostManagement operation fault code." + }, + "faultText": { + "type": "string", + "description": "SessionHostManagement operation fault text." + }, + "faultContext": { + "type": "string", + "description": "SessionHostManagement operation fault context." + } + } + }, + "ValidateSessionHostUpdateRequestBody": { + "description": "Object containing the definition for properties to be used in the sessionHostUpdate validation.", + "type": "object", + "properties": { + "sessionHostConfiguration": { + "description": "Object containing the definition for the SessionHostConfiguration to be validated. If none is provided the update will use the SessionHostConfiguration settings associated with the HostPool.", + "$ref": "#/definitions/SessionHostConfiguration" + }, + "sessionHostManagement": { + "description": "Object containing the definition for the SessionHostManagement to be validated. If none is provided the update will use the settings saved in the sessionHostManagement object.", + "$ref": "#/definitions/SessionHostManagement" + }, + "scheduledDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp that the update validation is scheduled for. If none is provided, the update will be executed immediately" + } + } + }, + "UpdateSessionHostsRequestBody": { + "description": "Object containing the definition for properties to be used for a sessionHostUpdate operation.", + "type": "object", + "properties": { + "scheduledDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp that the update validation is scheduled for. If none is provided, the update will be executed immediately" + }, + "scheduledDateTimeZone": { + "type": "string", + "description": "The timeZone as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid." + }, + "update": { + "description": "settings for management information for the hostpool update operation. If none is provided the update will use the settings saved in the sessionHostManagement object.", + "$ref": "#/definitions/HostPoolUpdateConfigurationPatchProperties" + } + } + }, + "SessionHostConfigurationOperationStatus": { + "description": "The current status of an async operation.", + "type": "object", + "required": [ + "status" + ], + "properties": { + "id": { + "description": "Fully qualified ID for the async operation.", + "type": "string" + }, + "name": { + "description": "Name of the async operation.", + "type": "string" + }, + "status": { + "description": "Operation status. Current defined values are ", + "type": "string" + }, + "percentComplete": { + "description": "Percent of the operation that is complete.", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "description": "The start time of the operation.", + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation.", + "type": "string", + "format": "date-time" + }, + "operations": { + "description": "The operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionHostConfigurationOperationStatus" + } + }, + "error": { + "description": "If present, details of the operation error.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + } + } + }, + "SessionHostConfigurationOperationStatusList": { + "type": "object", + "title": "OperationStatusList", + "description": "List of OperationStatus definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of OperationStatus definitions.", + "items": { + "$ref": "#/definitions/SessionHostConfigurationOperationStatus" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ActiveSessionHostConfigurationList": { + "type": "object", + "title": "ActiveSessionHostConfigurationList", + "description": "List of ActiveSessionHostConfiguration definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ActiveSessionHostConfiguration definitions.", + "items": { + "$ref": "#/definitions/ActiveSessionHostConfiguration" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ActiveSessionHostConfiguration": { + "type": "object", + "description": "Represents a ActiveSessionHostConfiguration definition. This has all of the sessionHostConfiguration properties except provisioningState", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for SessionHostConfiguration", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ActiveSessionHostConfigurationProperties" + } + } + }, + "ActiveSessionHostConfigurationProperties": { + "description": "Session host configurations of HostPool.", + "type": "object", + "required": [ + "vmNamePrefix", + "networkInfo", + "vmSizeId", + "diskInfo", + "imageInfo", + "domainInfo", + "vmAdminCredentials" + ], + "properties": { + "version": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "vmTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Hashtable that lists key/value pair tags to apply to the VMs" + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided." + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]." + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool." + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoProperties", + "description": "Boot Diagnostics information." + } + } + }, + "SessionHostConfigurationList": { + "type": "object", + "title": "SessionHostConfigurationList", + "description": "List of SessionHostConfiguration definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHostConfiguration definitions.", + "items": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "SessionHostConfiguration": { + "type": "object", + "description": "Represents a SessionHostConfiguration definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for SessionHostConfiguration", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostConfigurationProperties" + } + } + }, + "SessionHostConfigurationProperties": { + "description": "Session host configurations of HostPool.", + "type": "object", + "required": [ + "vmNamePrefix", + "networkInfo", + "vmSizeId", + "diskInfo", + "imageInfo", + "domainInfo", + "vmAdminCredentials" + ], + "properties": { + "version": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "provisioningState": { + "description": "Provisioning state of the Session Host Configuration.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningStateSHC", + "modelAsString": true + } + }, + "vmTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Hashtable that lists key/value pair tags to apply to the VMs" + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided." + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]." + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool." + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoProperties", + "description": "Boot Diagnostics information." + } + } + }, + "SessionHostConfigurationPatch": { + "type": "object", + "description": "Represents a SessionHostConfigurationPatch definition.", + "properties": { + "properties": { + "description": "Detailed properties for SessionHostConfigurationPatch", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostConfigurationPatchProperties" + } + } + }, + "SessionHostConfigurationPatchProperties": { + "description": "Session host configurations of HostPool.", + "type": "object", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "vmTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Hashtable that lists key/value pair tags to apply to the VMs" + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in" + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3]." + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool." + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoPatchProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning.", + "maxLength": 260 + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoPatchProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoPatchProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoPatchProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsPatchProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoPatchProperties", + "description": "Boot Diagnostics information." + } + } + }, + "DiskInfoProperties": { + "description": "Disk information.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "VirtualMachineDiskType", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + } + ] + }, + "description": "The disk type used by virtual machine in hostpool session host." + } + } + }, + "DiskInfoPatchProperties": { + "description": "Disk information.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "VirtualMachineDiskType", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + } + ] + }, + "description": "The disk type used by virtual machine in hostpool session host." + } + } + }, + "ImageInfoProperties": { + "description": "Image configurations of session host in a HostPool.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "enum": [ + "Marketplace", + "Custom" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "Marketplace", + "description": "Using default marketplace images offered by Azure Marketplace." + }, + { + "value": "Custom", + "description": "Using a custom image." + } + ] + }, + "type": "string", + "description": "The type of image session hosts use in the hostpool.", + "x-nullable": false + }, + "marketplaceInfo": { + "$ref": "#/definitions/MarketplaceInfoProperties", + "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type." + }, + "customInfo": { + "$ref": "#/definitions/CustomInfoProperties", + "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type." + } + } + }, + "ImageInfoPatchProperties": { + "description": "Image configurations of session host in a HostPool.", + "type": "object", + "properties": { + "type": { + "enum": [ + "Marketplace", + "Custom" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "Marketplace", + "description": "Using default marketplace images offered by Azure Marketplace." + }, + { + "value": "Custom", + "description": "Using a custom image." + } + ] + }, + "type": "string", + "description": "The type of image session hosts use in the hostpool.", + "x-nullable": false + }, + "marketplaceInfo": { + "$ref": "#/definitions/MarketplaceInfoPatchProperties", + "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type." + }, + "customInfo": { + "$ref": "#/definitions/CustomInfoPatchProperties", + "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type." + } + } + }, + "MarketplaceInfoProperties": { + "description": "Marketplace image information.", + "type": "object", + "required": [ + "offer", + "publisher", + "sku", + "exactVersion" + ], + "properties": { + "offer": { + "type": "string", + "description": "The offer of the image." + }, + "publisher": { + "type": "string", + "description": "The publisher of the image." + }, + "sku": { + "type": "string", + "description": "The sku of the image." + }, + "exactVersion": { + "type": "string", + "description": "The exact version of the image." + } + } + }, + "MarketplaceInfoPatchProperties": { + "description": "Marketplace image information.", + "type": "object", + "properties": { + "offer": { + "type": "string", + "description": "The offer of the image." + }, + "publisher": { + "type": "string", + "description": "The publisher of the image." + }, + "sku": { + "type": "string", + "description": "The sku of the image." + }, + "exactVersion": { + "type": "string", + "description": "The exact version of the image." + } + } + }, + "CustomInfoProperties": { + "description": "Custom image information.", + "type": "object", + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the custom image." + } + } + }, + "CustomInfoPatchProperties": { + "description": "Custom image information.", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource id of the custom image." + } + } + }, + "DomainInfoProperties": { + "description": "Domain configurations of session hosts.", + "type": "object", + "required": [ + "joinType" + ], + "properties": { + "joinType": { + "enum": [ + "ActiveDirectory", + "AzureActiveDirectory" + ], + "x-ms-enum": { + "name": "DomainJoinType", + "modelAsString": true, + "values": [ + { + "value": "ActiveDirectory", + "description": "Using microsoft active directory." + }, + { + "value": "AzureActiveDirectory", + "description": "Using microsoft azure active directory." + } + ] + }, + "type": "string", + "description": "The type of domain join done by the virtual machine.", + "x-nullable": false + }, + "activeDirectoryInfo": { + "$ref": "#/definitions/ActiveDirectoryInfoProperties", + "description": "Active directory info. Only one should be populated based on the join type." + }, + "azureActiveDirectoryInfo": { + "$ref": "#/definitions/AzureActiveDirectoryInfoProperties", + "description": "Azure active directory info. Only one should be populated based on the join type." + } + } + }, + "DomainInfoPatchProperties": { + "description": "Domain configurations of session hosts.", + "type": "object", + "properties": { + "activeDirectoryInfo": { + "$ref": "#/definitions/ActiveDirectoryInfoPatchProperties", + "description": "Active directory info. Only one should be populated based on the join type." + } + } + }, + "ActiveDirectoryInfoProperties": { + "description": "Active directory info. Only one should be populated based on the join type.", + "type": "object", + "required": [ + "domainCredentials", + "ouPath" + ], + "properties": { + "domainCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Credentials needed to create the virtual machine." + }, + "ouPath": { + "type": "string", + "description": "The ou path." + }, + "domainName": { + "type": "string", + "description": "The domain a virtual machine connected to a hostpool will join." + } + } + }, + "ActiveDirectoryInfoPatchProperties": { + "description": "Active directory info. Only one should be populated based on the join type.", + "type": "object", + "properties": { + "domainCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsPatchProperties", + "description": "Credentials needed to create the virtual machine." + } + } + }, + "AzureActiveDirectoryInfoProperties": { + "description": "Azure Active directory info. Only one should be populated based on the join type.", + "type": "object", + "required": [ + "mdmProviderGuid" + ], + "properties": { + "mdmProviderGuid": { + "type": "string", + "description": "The mdm guid." + } + } + }, + "KeyVaultCredentialsProperties": { + "description": "Credentials kept in the keyvault.", + "type": "object", + "required": [ + "usernameKeyVaultSecretUri", + "passwordKeyVaultSecretUri" + ], + "properties": { + "usernameKeyVaultSecretUri": { + "type": "string", + "description": "The uri to access the secret that the username is stored in." + }, + "passwordKeyVaultSecretUri": { + "type": "string", + "description": "The uri to access the secret that the password is stored in." + } + } + }, + "KeyVaultCredentialsPatchProperties": { + "description": "Credentials kept in the keyvault.", + "type": "object", + "properties": { + "usernameKeyVaultSecretUri": { + "type": "string", + "description": "The uri to access the secret that the username is stored in." + }, + "passwordKeyVaultSecretUri": { + "type": "string", + "description": "The uri to access the secret that the password is stored in." + } + } + }, + "NetworkInfoProperties": { + "description": "Network information.", + "type": "object", + "required": [ + "subnetId" + ], + "properties": { + "subnetId": { + "type": "string", + "description": "The resource ID of the subnet." + }, + "securityGroupId": { + "type": "string", + "description": "The resource ID of the security group. Any allowable/open ports should be specified in the NSG." + } + } + }, + "NetworkInfoPatchProperties": { + "description": "Network information.", + "type": "object", + "properties": { + "subnetId": { + "type": "string", + "description": "The resource ID of the subnet." + }, + "securityGroupId": { + "type": "string", + "description": "The resource ID of the security group. Any allowable/open ports should be specified in the NSG." + } + } + }, + "SecurityInfoProperties": { + "description": "Security information.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard", + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "VirtualMachineSecurityType", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard security protocol. No additional parameters" + }, + { + "value": "TrustedLaunch", + "description": "TrustedLaunch allows for secure boot adn vTPM" + }, + { + "value": "ConfidentialVM", + "description": "Confidential Virtual Machine security protocol" + } + ] + }, + "default": "Standard", + "description": "The security type used by virtual machine in hostpool session host. Default is Standard." + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Whether to use secureBoot on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Whether to use vTPM on the virtual machine." + } + } + }, + "SecurityInfoPatchProperties": { + "description": "Security information.", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Standard", + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "VirtualMachineSecurityType", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard security protocol. No additional parameters" + }, + { + "value": "TrustedLaunch", + "description": "TrustedLaunch allows for secure boot adn vTPM" + }, + { + "value": "ConfidentialVM", + "description": "Confidential Virtual Machine security protocol" + } + ] + }, + "description": "The security type used by virtual machine in hostpool session host." + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Whether to use secureBoot on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Whether to use vTPM on the virtual machine." + } + } + }, + "BootDiagnosticsInfoProperties": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot.

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

You can easily view the output of your console log.

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

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

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "RegistrationInfo": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token." + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string." + }, + "registrationTokenOperation": { + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true + }, + "type": "string", + "description": "The type of resetting the token.", + "x-nullable": false + } + } + }, + "RegistrationInfoPatch": { + "description": "Represents a RegistrationInfo definition.", + "type": "object", + "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token." + }, + "registrationTokenOperation": { + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true + }, + "type": "string", + "description": "The type of resetting the token." + } + } + }, + "AgentUpdateProperties": { + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of maintenance for session host components.", + "enum": [ + "Default", + "Scheduled" + ], + "x-ms-enum": { + "name": "SessionHostComponentUpdateType", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra." + }, + { + "value": "Scheduled", + "description": "TenantAdmin have opted in for Scheduled Component Update feature." + } + ] + } + }, + "useSessionHostLocalTime": { + "type": "boolean", + "description": "Whether to use localTime of the virtual machine." + }, + "maintenanceWindowTimeZone": { + "type": "string", + "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true." + }, + "maintenanceWindows": { + "type": "array", + "description": "List of maintenance windows. Maintenance windows are 2 hours long.", + "items": { + "$ref": "#/definitions/MaintenanceWindowProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "MaintenanceWindowProperties": { + "description": "Maintenance window starting hour and day of week.", + "type": "object", + "properties": { + "hour": { + "format": "int32", + "type": "integer", + "description": "The update start hour of the day. (0 - 23)" + }, + "dayOfWeek": { + "type": "string", + "description": "Day of the week.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + } + }, + "AgentUpdatePatchProperties": { + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of maintenance for session host components.", + "enum": [ + "Default", + "Scheduled" + ], + "x-ms-enum": { + "name": "SessionHostComponentUpdateType", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra." + }, + { + "value": "Scheduled", + "description": "TenantAdmin have opted in for Scheduled Component Update feature." + } + ] + } + }, + "useSessionHostLocalTime": { + "type": "boolean", + "description": "Whether to use localTime of the virtual machine." + }, + "maintenanceWindowTimeZone": { + "type": "string", + "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true." + }, + "maintenanceWindows": { + "type": "array", + "description": "List of maintenance windows. Maintenance windows are 2 hours long.", + "items": { + "$ref": "#/definitions/MaintenanceWindowPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "MaintenanceWindowPatchProperties": { + "description": "Maintenance window starting hour and day of week.", + "type": "object", + "properties": { + "hour": { + "format": "int32", + "type": "integer", + "description": "The update start hour of the day. (0 - 23)" + }, + "dayOfWeek": { + "type": "string", + "description": "Day of the week.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + } + }, + "SendMessage": { + "description": "Represents message sent to a UserSession.", + "type": "object", + "properties": { + "messageTitle": { + "type": "string", + "description": "Title of message." + }, + "messageBody": { + "type": "string", + "description": "Body of message." + } + } + }, + "HostPoolList": { + "type": "object", + "title": "HostPoolList", + "description": "List of HostPool definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of HostPool definitions.", + "items": { + "$ref": "#/definitions/HostPool" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "MSIXPackage": { + "description": "Schema for MSIX Package properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for MSIX Package", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MSIXPackageProperties", + "x-nullable": false + } + } + }, + "MSIXPackageProperties": { + "description": "Schema for MSIX Package properties.", + "type": "object", + "properties": { + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share.", + "x-nullable": false + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml. ", + "x-nullable": false + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ", + "x-nullable": false + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal. ", + "x-nullable": true + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image. ", + "x-nullable": false + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed.", + "x-nullable": false + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool. ", + "x-nullable": false + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies. ", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + } + }, + "version": { + "type": "string", + "description": "Package Version found in the appxmanifest.xml. ", + "x-nullable": false + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "description": "Date Package was last updated, found in the appxmanifest.xml. ", + "x-nullable": false + }, + "packageApplications": { + "type": "array", + "description": "List of package applications. ", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-nullable": false + } + } + }, + "MSIXPackagePatch": { + "type": "object", + "description": "MSIX Package properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for MSIX Package", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MSIXPackagePatchProperties" + } + } + }, + "MSIXPackagePatchProperties": { + "description": "MSIX Package properties that can be patched.", + "type": "object", + "properties": { + "isActive": { + "type": "boolean", + "description": "Set a version of the package to be active across hostpool. " + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Set Registration mode. Regular or Delayed." + }, + "displayName": { + "type": "string", + "description": "Display name for MSIX Package." + } + } + }, + "MsixPackageApplications": { + "description": "Schema for MSIX Package Application properties.", + "type": "object", + "properties": { + "appId": { + "type": "string", + "description": "Package Application Id, found in appxmanifest.xml.", + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Description of Package Application.", + "x-nullable": false + }, + "appUserModelID": { + "type": "string", + "description": "Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml.", + "x-nullable": false + }, + "friendlyName": { + "type": "string", + "description": "User friendly name.", + "x-nullable": false + }, + "iconImageName": { + "type": "string", + "description": "User friendly name.", + "x-nullable": false + }, + "rawIcon": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + }, + "rawPng": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "MsixPackageDependencies": { + "description": "Schema for MSIX Package Dependencies properties.", + "type": "object", + "properties": { + "dependencyName": { + "type": "string", + "description": "Name of package dependency.", + "x-nullable": false + }, + "publisher": { + "type": "string", + "description": "Name of dependency publisher.", + "x-nullable": false + }, + "minVersion": { + "type": "string", + "description": "Dependency version required.", + "x-nullable": false + } + } + }, + "MSIXPackageList": { + "type": "object", + "title": "MsixPackageList", + "description": "List of MSIX Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of MSIX Package definitions.", + "items": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "AppAttachPackage": { + "description": "Schema for App Attach Package properties.", + "type": "object", + "x-ms-client-flatten": false, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageProperties", + "x-nullable": false + } + } + }, + "AppAttachPackagePatch": { + "description": "Schema for patchable App Attach Package properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackagePatchProperties", + "x-ms-client-flatten": false, + "x-nullable": false + } + } + }, + "AppAttachPackageList": { + "type": "object", + "title": "AppAttachPackageList", + "description": "List of App Attach Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of App Attach Package definitions.", + "items": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "AppAttachPackageProperties": { + "description": "Schema for App Attach Package properties.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the App Attach Package." + }, + "image": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageInfoProperties", + "x-nullable": false + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string" + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL of keyvault location to store certificate" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/FailHealthCheckOnStagingFailureEnum", + "description": "Parameter indicating how the health check should behave if this package fails staging" + } + } + }, + "AppAttachPackagePatchProperties": { + "description": "Schema for patchable fields on an App Attach Package.", + "type": "object", + "properties": { + "image": { + "description": "Detailed properties for App Attach Package", + "$ref": "#/definitions/AppAttachPackageInfoProperties" + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string" + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL of keyvault location to store certificate" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/FailHealthCheckOnStagingFailureEnum", + "description": "Parameter indicating how the health check should behave if this package fails staging" + } + } + }, + "AppAttachPackageInfoProperties": { + "description": "Schema for Import Package Information properties.", + "type": "object", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of App Attach Package. Assigned at import time" + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share.", + "x-nullable": false + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml. ", + "x-nullable": false + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ", + "x-nullable": false + }, + "packageFullName": { + "type": "string", + "description": "Package Full Name from appxmanifest.xml. ", + "x-nullable": false + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal. ", + "x-nullable": true + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image. ", + "x-nullable": false + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed.", + "x-nullable": false + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool. ", + "x-nullable": false + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies. ", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-ms-identifiers": [], + "x-nullable": true + }, + "version": { + "type": "string", + "description": "Package Version found in the appxmanifest.xml. ", + "x-nullable": false + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "description": "Date Package was last updated, found in the appxmanifest.xml. ", + "x-nullable": false + }, + "packageApplications": { + "type": "array", + "description": "List of package applications. ", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-ms-identifiers": [], + "x-nullable": false + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml. ", + "x-nullable": true + }, + "certificateExpiry": { + "format": "date-time", + "type": "string", + "description": "Date certificate expires, found in the appxmanifest.xml. ", + "x-nullable": true + }, + "isPackageTimestamped": { + "enum": [ + "Timestamped", + "NotTimestamped" + ], + "x-ms-enum": { + "name": "packageTimestamped", + "modelAsString": true + }, + "type": "string", + "description": "Is package timestamped so it can ignore the certificate expiry date", + "x-nullable": true + } + } + }, + "ImportPackageInfoRequest": { + "description": "Information to import app attach package", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "URI to Image" + }, + "packageArchitecture": { + "enum": [ + "ARM", + "ARM64", + "x86", + "x64", + "Neutral", + "x86a64", + "ALL" + ], + "x-ms-enum": { + "name": "AppAttachPackageArchitectures", + "modelAsString": true + }, + "type": "string", + "description": "Possible device architectures that an app attach package can be configured for", + "x-nullable": true + } + } + }, + "FailHealthCheckOnStagingFailureEnum": { + "enum": [ + "Unhealthy", + "NeedsAssistance", + "DoNotFail" + ], + "x-ms-enum": { + "name": "failHealthCheckOnStagingFailure", + "modelAsString": true + }, + "type": "string", + "description": "Parameter indicating how the health check should behave if this package fails staging" + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Provisioning", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "Application": { + "description": "Schema for Application properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties", + "x-nullable": false + } + } + }, + "ApplicationProperties": { + "description": "Schema for Application properties.", + "type": "object", + "required": [ + "commandLineSetting" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Application. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "msixPackageFamilyName": { + "type": "string", + "description": "Specifies the package family name for MSIX applications", + "x-nullable": true, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "msixPackageApplicationId": { + "type": "string", + "description": "Specifies the package application Id for MSIX applications", + "x-nullable": true, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "applicationType": { + "enum": [ + "InBuilt", + "MsixApplication" + ], + "x-ms-enum": { + "name": "RemoteApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of Application.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", + "x-nullable": false + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "ApplicationList": { + "type": "object", + "title": "ApplicationList", + "description": "List of Application definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Application definitions.", + "items": { + "$ref": "#/definitions/Application" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ApplicationPatch": { + "type": "object", + "description": "Application properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Application", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationPatchProperties" + } + } + }, + "ApplicationPatchProperties": { + "description": "Application properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true + }, + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + }, + "msixPackageFamilyName": { + "type": "string", + "description": "Specifies the package family name for MSIX applications", + "x-nullable": true + }, + "msixPackageApplicationId": { + "type": "string", + "description": "Specifies the package application Id for MSIX applications", + "x-nullable": true + }, + "applicationType": { + "enum": [ + "InBuilt", + "MsixApplication" + ], + "x-ms-enum": { + "name": "RemoteApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Resource Type of Application." + } + } + }, + "Desktop": { + "description": "Schema for Desktop properties.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopProperties" + } + } + }, + "DesktopProperties": { + "description": "Schema for Desktop properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Desktop. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + }, + "iconHash": { + "readOnly": true, + "type": "string", + "description": "Hash of the icon." + }, + "iconContent": { + "readOnly": true, + "type": "string", + "format": "byte", + "description": "The icon a 64 bit string as a byte array." + } + } + }, + "DesktopList": { + "type": "object", + "title": "DesktopList", + "description": "List of Desktop definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of Desktop definitions.", + "items": { + "$ref": "#/definitions/Desktop" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "DesktopPatch": { + "type": "object", + "description": "Desktop properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DesktopPatchProperties" + } + } + }, + "DesktopPatchProperties": { + "description": "Desktop properties that can be patched.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + } + } + }, + "StartMenuItemProperties": { + "description": "Schema for StartMenuItem properties.", + "type": "object", + "properties": { + "appAlias": { + "type": "string", + "description": "Alias of StartMenuItem." + }, + "filePath": { + "type": "string", + "description": "Path to the file of StartMenuItem." + }, + "commandLineArguments": { + "type": "string", + "description": "Command line arguments for StartMenuItem." + }, + "iconPath": { + "type": "string", + "description": "Path to the icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + } + } + }, + "StartMenuItem": { + "type": "object", + "description": "Represents a StartMenuItem definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for StartMenuItem", + "x-ms-client-flatten": true, + "$ref": "#/definitions/StartMenuItemProperties" + } + } + }, + "StartMenuItemList": { + "type": "object", + "title": "StartMenuItemList", + "description": "List of StartMenuItem definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of StartMenuItem definitions.", + "items": { + "$ref": "#/definitions/StartMenuItem" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ExpandMsixImageProperties": { + "description": "Schema for Expand MSIX Image properties.", + "type": "object", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of MSIX Package." + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share.", + "x-nullable": false + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml. ", + "x-nullable": false + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. ", + "x-nullable": false + }, + "packageFullName": { + "type": "string", + "description": "Package Full Name from appxmanifest.xml. ", + "x-nullable": false + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal. ", + "x-nullable": true + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image. ", + "x-nullable": false + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed.", + "x-nullable": false + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool. ", + "x-nullable": false + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies. ", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-nullable": true + }, + "version": { + "type": "string", + "description": "Package Version found in the appxmanifest.xml. ", + "x-nullable": false + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "description": "Date Package was last updated, found in the appxmanifest.xml. ", + "x-nullable": false + }, + "packageApplications": { + "type": "array", + "description": "List of package applications. ", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-nullable": false + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml. ", + "x-nullable": true + }, + "certificateExpiry": { + "format": "date-time", + "type": "string", + "description": "Date certificate expires, found in the appxmanifest.xml. ", + "x-nullable": true + } + } + }, + "ExpandMsixImage": { + "type": "object", + "description": "Represents the definition of contents retrieved after expanding the MSIX Image. ", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for ExpandMsixImage", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpandMsixImageProperties" + } + } + }, + "ExpandMsixImageList": { + "type": "object", + "title": "ExpandMsixImageList", + "description": "List of MSIX package properties retrieved from MSIX Image expansion.", + "properties": { + "value": { + "type": "array", + "description": "List of MSIX package properties from give MSIX Image.", + "items": { + "$ref": "#/definitions/ExpandMsixImage" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "MSIXImageURI": { + "description": "Represents URI referring to MSIX Image", + "type": "object", + "properties": { + "uri": { + "type": "string", + "description": "URI to Image" + } + } + }, + "SessionHost": { + "type": "object", + "description": "Represents a SessionHost definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostProperties" + } + } + }, + "SessionHostProperties": { + "description": "Schema for SessionHost properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of SessionHost. (internal use)", + "readOnly": true + }, + "lastHeartBeat": { + "format": "date-time", + "type": "string", + "description": "Last heart beat from SessionHost." + }, + "sessions": { + "type": "integer", + "format": "int32", + "description": "Number of sessions on SessionHost." + }, + "agentVersion": { + "type": "string", + "description": "Version of agent on SessionHost." + }, + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of SessionHost" + }, + "status": { + "enum": [ + "Available", + "Unavailable", + "Shutdown", + "Disconnected", + "Upgrading", + "UpgradeFailed", + "NoHeartbeat", + "NotJoinedToDomain", + "DomainTrustRelationshipLost", + "SxSStackListenerNotReady", + "FSLogixNotHealthy", + "NeedsAssistance" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "value": "Available", + "description": "Session Host has passed all the health checks and is available to handle connections." + }, + { + "value": "Unavailable", + "description": "Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous 'NoHeartBeat' status." + }, + { + "value": "Shutdown", + "description": "Session Host is shutdown - RD Agent reported session host to be stopped or deallocated." + }, + { + "value": "Disconnected", + "description": "The Session Host is unavailable because it is currently disconnected." + }, + { + "value": "Upgrading", + "description": "Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections." + }, + { + "value": "UpgradeFailed", + "description": "Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed." + }, + { + "value": "NoHeartbeat", + "description": "The Session Host is not heart beating." + }, + { + "value": "NotJoinedToDomain", + "description": "SessionHost is not joined to domain." + }, + { + "value": "DomainTrustRelationshipLost", + "description": "SessionHost's domain trust relationship lost" + }, + { + "value": "SxSStackListenerNotReady", + "description": "SxS stack installed on the SessionHost is not ready to receive connections." + }, + { + "value": "FSLogixNotHealthy", + "description": "FSLogix is in an unhealthy state on the session host." + }, + { + "value": "NeedsAssistance", + "description": "New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal." + } + ] + }, + "type": "string", + "description": "Status for a SessionHost." + }, + "statusTimestamp": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the status.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "The version of the OS on the session host." + }, + "sxSStackVersion": { + "type": "string", + "description": "The version of the side by side stack on the session host." + }, + "updateState": { + "enum": [ + "Initial", + "Pending", + "Started", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "UpdateState", + "modelAsString": true + }, + "type": "string", + "description": "Update state of a SessionHost." + }, + "lastUpdateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "updateErrorMessage": { + "type": "string", + "description": "The error message." + }, + "lastSessionHostUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The last time update was completed.", + "readOnly": true + }, + "sessionHostConfiguration": { + "type": "string", + "description": "SessionHostConfiguration version reference at the time the update is initiated, in the format of date time.", + "readOnly": true + }, + "sessionHostHealthCheckResults": { + "type": "array", + "readOnly": true, + "description": "List of SessionHostHealthCheckReports", + "items": { + "$ref": "#/definitions/SessionHostHealthCheckReport" + } + } + } + }, + "SessionHostHealthCheckReport": { + "type": "object", + "description": "The report for session host information.", + "properties": { + "healthCheckName": { + "enum": [ + "DomainJoinedCheck", + "DomainTrustCheck", + "FSLogixHealthCheck", + "SxSStackListenerCheck", + "UrlsAccessibleCheck", + "MonitoringAgentCheck", + "DomainReachable", + "WebRTCRedirectorCheck", + "SupportedEncryptionCheck", + "MetaDataServiceCheck", + "AppAttachHealthCheck" + ], + "x-ms-enum": { + "name": "HealthCheckName", + "modelAsString": true, + "values": [ + { + "value": "DomainJoinedCheck", + "description": "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)" + }, + { + "value": "DomainTrustCheck", + "description": "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)" + }, + { + "value": "FSLogixHealthCheck", + "description": "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)" + }, + { + "value": "SxSStackListenerCheck", + "description": "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)" + }, + { + "value": "UrlsAccessibleCheck", + "description": "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)" + }, + { + "value": "MonitoringAgentCheck", + "description": "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)" + }, + { + "value": "DomainReachable", + "description": "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)" + }, + { + "value": "WebRTCRedirectorCheck", + "description": "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)" + }, + { + "value": "SupportedEncryptionCheck", + "description": "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)" + }, + { + "value": "MetaDataServiceCheck", + "description": "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)" + }, + { + "value": "AppAttachHealthCheck", + "description": "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)" + } + ] + }, + "type": "string", + "description": "Represents the name of the health check operation performed.", + "readOnly": true + }, + "healthCheckResult": { + "enum": [ + "Unknown", + "HealthCheckSucceeded", + "HealthCheckFailed", + "SessionHostShutdown" + ], + "x-ms-enum": { + "name": "HealthCheckResult", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Health check result is not currently known." + }, + { + "value": "HealthCheckSucceeded", + "description": "Health check passed." + }, + { + "value": "HealthCheckFailed", + "description": "Health check failed." + }, + { + "value": "SessionHostShutdown", + "description": "We received a Shutdown notification." + } + ] + }, + "type": "string", + "description": "Represents the Health state of the health check we performed.", + "readOnly": true + }, + "additionalFailureDetails": { + "$ref": "#/definitions/SessionHostHealthCheckFailureDetails", + "description": "Additional detailed information on the failure.", + "readOnly": true + } + } + }, + "SessionHostHealthCheckFailureDetails": { + "type": "object", + "description": "Contains details on the failure.", + "properties": { + "message": { + "type": "string", + "description": "Failure message: hints on what is wrong and how to recover.", + "readOnly": true + }, + "errorCode": { + "type": "integer", + "format": "int32", + "description": "Error code corresponding for the failure.", + "readOnly": true + }, + "lastHealthCheckDateTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the last update.", + "readOnly": true + } + } + }, + "SessionHostPatch": { + "type": "object", + "description": "SessionHost properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SessionHostPatchProperties" + } + } + }, + "SessionHostPatchProperties": { + "description": "SessionHost properties that can be patched.", + "type": "object", + "properties": { + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of SessionHost" + } + } + }, + "SessionHostList": { + "type": "object", + "title": "SessionHostList", + "description": "List of SessionHost definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of SessionHost definitions.", + "items": { + "$ref": "#/definitions/SessionHost" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "UserSession": { + "type": "object", + "description": "Represents a UserSession definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for UserSession", + "x-ms-client-flatten": true, + "$ref": "#/definitions/UserSessionProperties" + } + } + }, + "UserSessionProperties": { + "description": "Schema for UserSession properties.", + "type": "object", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of user session. (internal use)", + "readOnly": true + }, + "userPrincipalName": { + "type": "string", + "description": "The user principal name." + }, + "applicationType": { + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "type": "string", + "description": "Application type of application." + }, + "sessionState": { + "enum": [ + "Unknown", + "Active", + "Disconnected", + "Pending", + "LogOff", + "UserProfileDiskMounted" + ], + "x-ms-enum": { + "name": "SessionState", + "modelAsString": true + }, + "type": "string", + "description": "State of user session." + }, + "activeDirectoryUserName": { + "type": "string", + "description": "The active directory user name." + }, + "createTime": { + "format": "date-time", + "type": "string", + "description": "The timestamp of the user session create." + } + } + }, + "UserSessionList": { + "type": "object", + "title": "UserSessionList", + "description": "List of UserSession definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of UserSession definitions.", + "items": { + "$ref": "#/definitions/UserSession" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlan": { + "type": "object", + "title": "ScalingPlan", + "description": "Represents a scaling plan definition.", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ResourceModelWithAllowedPropertySet" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for scaling plan.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanProperties", + "x-nullable": false + } + } + }, + "ScalingPlanProperties": { + "type": "object", + "description": "Scaling plan properties.", + "required": [ + "timeZone" + ], + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of scaling plan. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of scaling plan." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name of scaling plan." + }, + "timeZone": { + "type": "string", + "description": "Timezone of the scaling plan." + }, + "hostPoolType": { + "enum": [ + "Pooled" + ], + "x-ms-enum": { + "name": "ScalingHostPoolType", + "modelAsString": true, + "values": [ + { + "value": "Pooled", + "description": "Users get a new (random) SessionHost every time it connects to the HostPool." + } + ] + }, + "default": "Pooled", + "type": "string", + "description": "HostPool type for desktop.", + "x-nullable": false + }, + "exclusionTag": { + "type": "string", + "description": "Exclusion tag for scaling plan." + }, + "schedules": { + "type": "array", + "description": "List of ScalingPlanPooledSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingSchedule" + } + }, + "hostPoolReferences": { + "type": "array", + "description": "List of ScalingHostPoolReference definitions.", + "items": { + "$ref": "#/definitions/ScalingHostPoolReference" + } + } + } + }, + "ScalingSchedule": { + "description": "A ScalingPlanPooledSchedule.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the ScalingPlanPooledSchedule." + }, + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string" + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp up period." + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp up period." + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp down period." + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp down period." + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "enum": [ + "ZeroSessions", + "ZeroActiveSessions" + ], + "x-ms-enum": { + "name": "StopHostsWhen", + "modelAsString": true + }, + "type": "string", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "ScalingPlanPooledSchedulePatch": { + "type": "object", + "description": "ScalingPlanPooledSchedule properties that can be patched.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for ScalingPlanPooledSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPooledScheduleProperties" + } + } + }, + "ScalingPlanPooledScheduleList": { + "type": "object", + "title": "ScalingPlanPooledScheduleList", + "description": "List of ScalingPlanPooledSchedule definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ScalingPlanPooledSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlanPooledSchedule": { + "type": "object", + "description": "Represents a ScalingPlanPooledSchedule definition.", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for ScalingPlanPooledSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPooledScheduleProperties", + "x-nullable": false + } + } + }, + "ScalingPlanPooledScheduleProperties": { + "description": "A ScalingPlanPooledSchedule.", + "type": "object", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp up period." + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp up period." + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "Minimum host percentage for ramp down period." + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "description": "Capacity threshold for ramp down period." + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "enum": [ + "ZeroSessions", + "ZeroActiveSessions" + ], + "x-ms-enum": { + "name": "StopHostsWhen", + "modelAsString": true + }, + "type": "string", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true + }, + "type": "string", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "Time": { + "description": "The time for a scaling action to occur.", + "required": [ + "hour", + "minute" + ], + "type": "object", + "properties": { + "hour": { + "format": "int32", + "description": "The hour.", + "maximum": 23, + "minimum": 0, + "type": "integer" + }, + "minute": { + "format": "int32", + "description": "The minute.", + "maximum": 59, + "minimum": 0, + "type": "integer" + } + } + }, + "ScalingHostPoolReference": { + "description": "Scaling plan reference to hostpool.", + "type": "object", + "properties": { + "hostPoolArmPath": { + "type": "string", + "description": "Arm path of referenced hostpool." + }, + "scalingPlanEnabled": { + "type": "boolean", + "description": "Is the scaling plan enabled for this hostpool." + } + } + }, + "ScalingPlanList": { + "type": "object", + "title": "ScalingPlanList", + "description": "List of scaling plan definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of scaling plan definitions.", + "items": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlanPatch": { + "type": "object", + "description": "Scaling plan properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "tags to be updated" + }, + "properties": { + "description": "Detailed properties for scaling plan", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPatchProperties" + } + } + }, + "ScalingPlanPatchProperties": { + "type": "object", + "description": "Scaling plan properties.", + "properties": { + "description": { + "type": "string", + "description": "Description of scaling plan." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name of scaling plan." + }, + "timeZone": { + "type": "string", + "description": "Timezone of the scaling plan." + }, + "exclusionTag": { + "type": "string", + "description": "Exclusion tag for scaling plan." + }, + "schedules": { + "type": "array", + "description": "List of ScalingSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingSchedule" + } + }, + "hostPoolReferences": { + "type": "array", + "description": "List of ScalingHostPoolReference definitions.", + "items": { + "$ref": "#/definitions/ScalingHostPoolReference" + } + } + } + }, + "PrivateEndpointConnectionWithSystemData": { + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateEndpointConnection" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResultWithSystemData": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + }, + "description": "List of private endpoint connection associated with the specified storage account" + }, + "ScalingPlanPersonalSchedulePatch": { + "type": "object", + "description": "ScalingPlanPersonalSchedule properties that can be patched.", + "properties": { + "properties": { + "description": "Detailed properties for ScalingPlanPersonalSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPersonalScheduleProperties" + } + } + }, + "ScalingPlanPersonalScheduleList": { + "type": "object", + "title": "ScalingPlanPersonalScheduleList", + "description": "List of ScalingPlanPersonalSchedule definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of ScalingPlanPersonalSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ScalingPlanPersonalSchedule": { + "type": "object", + "description": "Represents a ScalingPlanPersonalSchedule definition.", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." + }, + "properties": { + "description": "Detailed properties for ScalingPlanPersonalSchedule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScalingPlanPersonalScheduleProperties", + "x-nullable": false + } + } + }, + "ScalingPlanPersonalScheduleProperties": { + "description": "A ScalingPlanPersonalSchedule.", + "type": "object", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpAutoStartHosts": { + "enum": [ + "None", + "WithAssignedUser", + "All" + ], + "x-ms-enum": { + "name": "StartupBehavior", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts." + }, + { + "value": "WithAssignedUser", + "description": "Session hosts with an assigned user will be started during Ramp Up" + }, + { + "value": "All", + "description": "All personal session hosts in the hostpool will be started during ramp up." + } + ] + }, + "type": "string", + "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool." + }, + "rampUpStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually." + }, + "rampUpActionOnDisconnect": { + "enum": [ + "None", + "Deallocate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the ramp up period." + }, + "rampUpMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period." + }, + "rampUpActionOnLogoff": { + "enum": [ + "None", + "Deallocate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the ramp up period." + }, + "rampUpMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period." + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the peak phase." + }, + "peakActionOnDisconnect": { + "enum": [ + "None", + "Deallocate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the peak period." + }, + "peakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period." + }, + "peakActionOnLogoff": { + "enum": [ + "None", + "Deallocate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the peak period." + }, + "peakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp down phase." + }, + "rampDownActionOnDisconnect": { + "enum": [ + "None", + "Deallocate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the ramp down period." + }, + "rampDownMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period." + }, + "rampDownActionOnLogoff": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the ramp down period." + }, + "rampDownMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakStartVMOnConnect": { + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true + }, + "default": "Enable", + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the off-peak phase." + }, + "offPeakActionOnDisconnect": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a user disconnect during the off-peak period." + }, + "offPeakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period." + }, + "offPeakActionOnLogoff": { + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true + }, + "type": "string", + "description": "Action to be taken after a logoff during the off-peak period." + }, + "offPeakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period." + } + } + } + }, + "parameters": { + "HostPoolNameParameter": { + "name": "hostPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the host pool within the specified resource group", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "MSIXPackageFullNameParameter": { + "name": "msixPackageFullName", + "in": "path", + "required": true, + "type": "string", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "maxLength": 100, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "AppAttachPackageNameParameter": { + "name": "appAttachPackageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the App Attach package arm object", + "maxLength": 100, + "minLength": 3, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$", + "x-ms-parameter-location": "method" + }, + "ApplicationGroupNameParameter": { + "name": "applicationGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application group", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application within the specified application group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "DesktopNameParameter": { + "name": "desktopName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the desktop within the specified desktop group", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "SessionHostNameParameter": { + "name": "sessionHostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the session host within the specified host pool", + "maxLength": 48, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "UserSessionIdParameter": { + "name": "userSessionId", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user session within the specified session host", + "maxLength": 24, + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "StartMenuItemNameParameter": { + "name": "startMenuItemName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the start menu item within the specified host pool", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "MSIXImageURIParameter": { + "name": "msixImageURI", + "in": "path", + "required": true, + "type": "string", + "description": "URI to the MSIX Image (VHD/CIM).", + "maxLength": 100, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ScalingPlanNameParameter": { + "name": "scalingPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the scaling plan.", + "maxLength": 64, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ScalingPlanScheduleNameParameter": { + "name": "scalingPlanScheduleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ScalingPlanSchedule", + "maxLength": 64, + "minLength": 1, + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The Guid of the operation.", + "maxLength": 36, + "minLength": 36, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ActiveSessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ActiveSessionHostConfigurations_Get.json new file mode 100644 index 000000000000..554591de00e5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ActiveSessionHostConfigurations_Get.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..d41eca65f8ef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackageInfo_Import_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackageInfo_Import_Post.json new file mode 100644 index 000000000000..11e67266cfcb --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackageInfo_Import_Post.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2023-11-01-preview", + "importPackageInfoRequest": { + "path": "imagepath", + "packageArchitecture": "x64" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Create.json new file mode 100644 index 000000000000..4b6ae3887116 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Create.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2023-11-01-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackage": { + "location": "southcentralus", + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + }, + "201": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Delete.json new file mode 100644 index 000000000000..9869f65ed68c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Delete.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2023-11-01-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Get.json new file mode 100644 index 000000000000..4126ef258525 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2023-11-01-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_ListByResourceGroup.json new file mode 100644 index 000000000000..1779a9abedff --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_ListByResourceGroup.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2023-11-01-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_ListBySubscription.json new file mode 100644 index 000000000000..a1e48cca76c1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_ListBySubscription.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2023-11-01-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Update.json new file mode 100644 index 000000000000..cef1b646670f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/AppAttachPackage_Update.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2023-11-01-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackage": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [ + "hostpool1", + "hostpool2" + ], + "keyVaultURL": "url", + "failHealthCheckOnStagingFailure": false + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Create.json new file mode 100644 index 000000000000..9f203395a81a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Create.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2023-11-01-preview", + "applicationGroup": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "applicationGroupType": "RemoteApp", + "showInFeed": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + }, + "201": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Delete.json new file mode 100644 index 000000000000..3fb4eaa7a1a9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Delete.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Get.json new file mode 100644 index 000000000000..59390cd9f4c2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_ListByResourceGroup.json new file mode 100644 index 000000000000..9f92c2e095cc --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_ListByResourceGroup.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2023-11-01-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_ListBySubscription.json new file mode 100644 index 000000000000..ac0da637d79c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_ListBySubscription.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2023-11-01-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Update.json new file mode 100644 index 000000000000..e58f05667959 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ApplicationGroup_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2023-11-01-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "showInFeed": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Create.json new file mode 100644 index 000000000000..c9b23ca56f0d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Create.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2023-11-01-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "201": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Delete.json new file mode 100644 index 000000000000..35df707742a3 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Delete.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Get.json new file mode 100644 index 000000000000..697562564f4f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_List.json new file mode 100644 index 000000000000..a1d75785242e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + { + "name": "applicationGroup1/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des2", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Update.json new file mode 100644 index 000000000000..8d326a1b6817 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Application_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2023-11-01-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Desktop_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Desktop_Get.json new file mode 100644 index 000000000000..380dfa7aca5f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Desktop_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Desktop_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Desktop_List.json new file mode 100644 index 000000000000..1bb3439dde2d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Desktop_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Desktop_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Desktop_Update.json new file mode 100644 index 000000000000..49c1f6330af8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Desktop_Update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2023-11-01-preview", + "desktop": { + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Create.json new file mode 100644 index 000000000000..f28f475f9cbd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Create.json @@ -0,0 +1,175 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "hostPool": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + } + }, + "201": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Delete.json new file mode 100644 index 000000000000..1f78b3d0411f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Delete.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Get.json new file mode 100644 index 000000000000..a81c9d15d34b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + } + }, + "default": { + "body": { + "error": { + "code": "hostPoolDoesNotExist", + "message": "Host Pool Does Not Exist" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_List.json new file mode 100644 index 000000000000..4339bc6d4858 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_List.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_ListByResourceGroup.json new file mode 100644 index 000000000000..cc69a5df1792 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_ListByResourceGroup.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Update.json new file mode 100644 index 000000000000..9f9d3ff48443 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPool_Update.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "hostPool": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "personalDesktopAssignmentType": "Automatic", + "registrationInfo": { + "expirationTime": "2020-10-01T15:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPools_RetrieveRegistrationToken_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPools_RetrieveRegistrationToken_Post.json new file mode 100644 index 000000000000..f7cbfe874c47 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/HostPools_RetrieveRegistrationToken_Post.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixImage_Expand_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixImage_Expand_Post.json new file mode 100644 index 000000000000..f205d63c2a19 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixImage_Expand_Post.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2023-11-01-preview", + "msixImageURI": { + "uri": "imagepath" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias2", + "imagePath": "imagepath", + "packageName": "MsixPackageName2", + "packageFamilyName": "MsixPackage_FamilyName2", + "packageFullName": "MsixPackage_FullName2", + "displayName": "displayname2", + "packageRelativePath": "packagerelativepath2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackageDependency1", + "publisher": "PublisherName1", + "minVersion": "ver1" + }, + { + "dependencyName": "MsixPackageDependency2", + "publisher": "PublisherName2", + "minVersion": "ver2" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId1", + "description": "PackageApplicationDescription1", + "appUserModelID": "AppUserModelId1", + "friendlyName": "FriendlyName1", + "iconImageName": "Iconimagename1", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + }, + { + "appId": "AppId2", + "description": "PackageApplicationDescription2", + "appUserModelID": "AppUserModelId2", + "friendlyName": "FriendlyName2", + "iconImageName": "Iconimagename2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Create.json new file mode 100644 index 000000000000..2d0ab3410b83 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Create.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2023-11-01-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "description": "application-desc", + "appId": "ApplicationId", + "appUserModelID": "AppUserModelId", + "friendlyName": "friendlyname", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixTest_Dependency_Name", + "minVersion": "version", + "publisher": "PublishedName" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageName": "MsixPackage_name", + "packageRelativePath": "packagerelativepath", + "version": "version" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + }, + "201": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Delete.json new file mode 100644 index 000000000000..72bf4f793f4b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Delete.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2023-11-01-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Get.json new file mode 100644 index 000000000000..a6c832503063 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2023-11-01-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_List.json new file mode 100644 index 000000000000..c0bf7a1c50d2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_List.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/MsixPackageFullName2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName2", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath2", + "packageName": "MsixPackage_Name2", + "packageFamilyName": "MsixPackage_FamilyName2", + "displayName": "dis2", + "packageRelativePath": "MsixPackage_RelativePackageRoot2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name2", + "publisher": "MsixPackage_Dependency_Publisher2", + "minVersion": "packageDep_version2" + } + ], + "version": "version2", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id2", + "description": "desc2", + "appUserModelID": "Application_ModelID2", + "friendlyName": "fri2", + "iconImageName": "Apptile2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Update.json new file mode 100644 index 000000000000..69d54bbce84a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/MsixPackage_Update.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2023-11-01-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "isActive": true, + "isRegularRegistration": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/OperationDescription_List.json new file mode 100644 index 000000000000..9ac2883ff624 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/OperationDescription_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/hostpools/read", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "hostpools", + "operation": "Read hostpool", + "description": "Read hostpool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.DesktopVirtualization/hostpools/write", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "hostpools", + "operation": "Write hostpool", + "description": "Write hostpool" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "", + "displayName": "" + }, + { + "name": "", + "displayName": "" + }, + { + "name": "", + "displayName": "" + } + ] + } + }, + "isDataAction": false + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json new file mode 100644 index 000000000000..a9ee4eec4bcf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_DeleteByHostPool.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json new file mode 100644 index 000000000000..c535aee824f7 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_DeleteByWorkspace.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_GetByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_GetByHostPool.json new file mode 100644 index 000000000000..b36afe04fbee --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_GetByHostPool.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_GetByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_GetByWorkspace.json new file mode 100644 index 000000000000..41dc9892f2a2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_GetByWorkspace.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_ListByHostPool.json new file mode 100644 index 000000000000..c6b9cb65f359 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_ListByHostPool.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_ListByWorkspace.json new file mode 100644 index 000000000000..78421deb053a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_ListByWorkspace.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json new file mode 100644 index 000000000000..8dbb04ad33ab --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_UpdateByHostPool.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2023-11-01-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json new file mode 100644 index 000000000000..826724e0a4f6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateEndpointConnection_UpdateByWorkspace.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2023-11-01-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateLinkResources_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateLinkResources_ListByHostPool.json new file mode 100644 index 000000000000..615e90d1cf97 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateLinkResources_ListByHostPool.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateLinkResources/hostpool", + "type": "Microsoft.DesktopVirtualization/hostpools/privateLinkResources", + "properties": { + "groupId": "hostpool", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateLinkResources_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateLinkResources_ListByWorkspace.json new file mode 100644 index 000000000000..d68a7a2d8186 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/PrivateLinkResources_ListByWorkspace.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateLinkResources/workspace", + "type": "Microsoft.DesktopVirtualization/workspaces/privateLinkResources", + "properties": { + "groupId": "workspace", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Create.json new file mode 100644 index 000000000000..0634ca8fcc26 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Create.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2023-11-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Delete.json new file mode 100644 index 000000000000..ea748fd40510 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Get.json new file mode 100644 index 000000000000..9d8a101fb735 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Get.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "PersonalScalingPlan1", + "scalingPlanScheduleName": "PersonalScalingPlanSchedule", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "PersonalScalingPlanSchedule", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/PersonalScalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_List.json new file mode 100644 index 000000000000..c259e6544ab8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_List.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekday", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + }, + { + "name": "scalingPlanScheduleWeekend", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 10, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 14, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "Deallocate", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 16, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "Deallocate", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Update.json new file mode 100644 index 000000000000..8aa9bf062fc0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPersonalSchedule_Update.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2023-11-01-preview", + "scalingPlanSchedule": { + "properties": { + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Create.json new file mode 100644 index 000000000000..e275030980e5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Create.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2023-11-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Delete.json new file mode 100644 index 000000000000..ea748fd40510 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Get.json new file mode 100644 index 000000000000..dff5fe0b45ec --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_List.json new file mode 100644 index 000000000000..19bc703666bb --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_List.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + }, + { + "name": "scalingPlanScheduleWeekends1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 10, + "rampUpCapacityThresholdPct": 90, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 0, + "rampDownCapacityThresholdPct": 100, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Update.json new file mode 100644 index 000000000000..4b39acd2ede3 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlanPooledSchedule_Update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2023-11-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownWaitTimeMinutes": 30 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Create.json new file mode 100644 index 000000000000..a3d2fc818e2c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Create.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2023-11-01-preview", + "scalingPlan": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "201": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Delete.json new file mode 100644 index 000000000000..244fa947717f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Delete.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Get.json new file mode 100644 index 000000000000..b2df9dde78e5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Get.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of scaling plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_ListByHostPool.json new file mode 100644 index 000000000000..aa8ef5a266af --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_ListByHostPool.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_ListByResourceGroup.json new file mode 100644 index 000000000000..768c37386e35 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_ListByResourceGroup.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_ListBySubscription.json new file mode 100644 index 000000000000..93e3a2f11902 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_ListBySubscription.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroActiveSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Update.json new file mode 100644 index 000000000000..049af1addf2a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/ScalingPlan_Update.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2023-11-01-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurationsOperationStatus_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurationsOperationStatus_Get.json new file mode 100644 index 000000000000..5b3cfd4ad513 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurationsOperationStatus_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "operationId": "55582798-3f6e-4cda-9371-8723b27bd664" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationresults/30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "operations": [], + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurationsOperationStatus_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurationsOperationStatus_List.json new file mode 100644 index 000000000000..a32c4fbaee7a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurationsOperationStatus_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "isLatest": true, + "isNonTerminal": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Kusto/locations/westus/operationresults/30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "operations": [], + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_Create.json new file mode 100644 index 000000000000..49161f81c988 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_Create.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_Get.json new file mode 100644 index 000000000000..875ad83a55fc --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_Get.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..2c6e6937b3f2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_Update.json new file mode 100644 index 000000000000..43ca8e0bfba9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostConfigurations_Update.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "Second Version, Updated Location", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + } + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagementsOperationStatus_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagementsOperationStatus_Get.json new file mode 100644 index 000000000000..b6fd7f99fba0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagementsOperationStatus_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "operationId": "12345678-1234-1234-1234-123456789012", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/12345678-1234-1234-1234-123456789012", + "name": "12345678-1234-1234-1234-123456789012", + "status": "Failed", + "startTime": "2020-07-10T15:00:00.000Z", + "endTime": "2020-07-11T15:00:00.000Z", + "percentComplete": 0.0, + "operations": [], + "error": { + "code": "ProvisioningError", + "message": "Provision 200 session hosts. \nTime Stamp: '2008-09-22T14:01:54.9571247Z' \nRequests: 120, 80. \nCanary Succeeded. \n120 successful. \n80 failed. \nSession Host Configuration Version '2008-09-22T14:01:54.9571247Z'. \n'Error code 'AADJoinFailed'. Message: User name or password is incorrect. Session Hosts: 'brman-abc1.mycompany.azure.com, brman- abc3.mycompany.azure.com, brman-abc4.mycompany.azure.com ...' \nError code 'RDAgentInstallationFailed'. Message: Failed to download RDAgent installer. Session Hosts: 'brman-abc6.mycompany.azure.com, brman-abc7.mycompany.azure.com, brman-abc8.mycompany.azure.com ...'" + }, + "properties": { + "correlationId": "2fa5c06c-2771-448b-a71e-e1124f44907f", + "type": "InitiateSessionHostUpdate | ValidateSessionHostUpdate", + "action": "Start | Retry | Pause | Resume | Cancel", + "progress": { + "executionStartTime": "2020-10-01T14:01:54.9571247Z", + "totalSessionHosts": 1, + "sessionHostsInProgress": 1, + "sessionHostsCompleted": 1, + "sessionHostsRollbackFailed": 1 + }, + "scheduledDateTime": "2020-10-01T14:01:54.9571247Z", + "sessionHostManagement": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "Logging off for host pool update" + } + } + }, + "parentId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/0000000-1234-1234-1234-000000000" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagementsOperationStatus_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagementsOperationStatus_List.json new file mode 100644 index 000000000000..b612edf8b294 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagementsOperationStatus_List.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "isLatest": false, + "type": "InitiateSessionHostUpdate", + "isNonTerminal": true, + "correlationId": "2fa5c06c-2771-448b-a71e-e1124f44907f", + "action": "", + "isInitiatingOperation": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/12345678-1234-1234-1234-123456789012", + "name": "12345678-1234-1234-1234-123456789012", + "status": "Failed", + "startTime": "2020-07-10T15:00:00.000Z", + "endTime": "2020-07-11T15:00:00.000Z", + "percentComplete": 0.0, + "operations": [], + "error": { + "code": "ProvisioningError", + "message": "Provision 200 session hosts. \nTime Stamp: '2008-09-22T14:01:54.9571247Z' \nRequests: 120, 80. \nCanary Succeeded. \n120 successful. \n80 failed. \nSession Host Configuration Version '2008-09-22T14:01:54.9571247Z'. \n'Error code 'AADJoinFailed'. Message: User name or password is incorrect. Session Hosts: 'brman-abc1.mycompany.azure.com, brman- abc3.mycompany.azure.com, brman-abc4.mycompany.azure.com ...' \nError code 'RDAgentInstallationFailed'. Message: Failed to download RDAgent installer. Session Hosts: 'brman-abc6.mycompany.azure.com, brman-abc7.mycompany.azure.com, brman-abc8.mycompany.azure.com ...'" + }, + "properties": { + "correlationId": "2fa5c06c-2771-448b-a71e-e1124f44907f", + "type": "InitiateSessionHostUpdate | ValidateSessionHostUpdate", + "action": "Start | Retry | Pause | Resume | Cancel", + "progress": { + "executionStartTime": "2020-10-01T14:01:54.9571247Z", + "totalSessionHosts": 1, + "sessionHostsInProgress": 1, + "sessionHostsCompleted": 1, + "sessionHostsRollbackFailed": 1 + }, + "scheduledDateTime": "2020-10-01T14:01:54.9571247Z", + "sessionHostManagement": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "Logging off for host pool update" + } + } + }, + "parentId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/0000000-1234-1234-1234-000000000" + } + }, + { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/2fa5c06c-2771-448b-a71e-e1124f44907f", + "name": "2fa5c06c-2771-448b-a71e-e1124f44907f", + "status": "Failed", + "startTime": "2020-07-10T15:00:00.000Z", + "endTime": "2020-07-11T15:00:00.000Z", + "percentComplete": 0.0, + "operations": [], + "error": { + "code": "ProvisioningError", + "message": "Provision 200 session hosts. \nTime Stamp: '2008-09-22T14:01:54.9571247Z' \nRequests: 120, 80. \nCanary Succeeded. \n120 successful. \n80 failed. \nSession Host Configuration Version '2008-09-22T14:01:54.9571247Z'. \n'Error code 'AADJoinFailed'. Message: User name or password is incorrect. Session Hosts: 'brman-abc1.mycompany.azure.com, brman- abc3.mycompany.azure.com, brman-abc4.mycompany.azure.com ...' \nError code 'RDAgentInstallationFailed'. Message: Failed to download RDAgent installer. Session Hosts: 'brman-abc6.mycompany.azure.com, brman-abc7.mycompany.azure.com, brman-abc8.mycompany.azure.com ...'" + }, + "properties": { + "correlationId": "2fa5c06c-2771-448b-a71e-e1124f44907f", + "type": "InitiateSessionHostUpdate | ValidateSessionHostUpdate", + "action": "Start | Retry | Pause | Resume | Cancel", + "progress": { + "executionStartTime": "2020-10-01T14:01:54.9571247Z", + "totalSessionHosts": 1, + "sessionHostsInProgress": 1, + "sessionHostsCompleted": 1, + "sessionHostsRollbackFailed": 1 + }, + "scheduledDateTime": "2020-10-01T14:01:54.9571247Z", + "sessionHostManagement": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "Logging off for host pool update" + } + } + }, + "parentId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/0000000-1234-1234-1234-000000000" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json new file mode 100644 index 000000000000..288b3a3778e8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "hostPoolControlParameter": { + "action": "Start", + "cancelMessage": "Host pool update started" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_Create.json new file mode 100644 index 000000000000..0b1735ef5150 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_Create.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_Get.json new file mode 100644 index 000000000000..1955bfd64f10 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_ListByHostPool.json new file mode 100644 index 000000000000..d5e9527457ef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_ListByHostPool.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_Update.json new file mode 100644 index 000000000000..24d8fcd9fbef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_Update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json new file mode 100644 index 000000000000..b4427edbca44 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "updateSessionHostsRequestBody": { + "scheduledDateTime": "2008-09-22T14:01:54.9571247Z", + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_ValidateSessionHostUpdate_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_ValidateSessionHostUpdate_Post.json new file mode 100644 index 000000000000..bb2526a77aff --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHostManagements_ValidateSessionHostUpdate_Post.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "validateSessionHostUpdateRequestBody": { + "sessionHostConfiguration": { + "properties": { + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "type": "Standard_LRS" + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroupName/providers/Microsoft.Storage/storageAccounts/storageAccountName" + } + } + }, + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + }, + "scheduledDateTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_Delete.json new file mode 100644 index 000000000000..925022a51e14 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_Delete.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2023-11-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_Get.json new file mode 100644 index 000000000000..b48ac7678330 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_List.json new file mode 100644 index 000000000000..dad54520ed12 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_List.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + { + "name": "sessionHost2.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user2@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_RetryProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_RetryProvisioning_Post.json new file mode 100644 index 000000000000..181e3e5aa3fb --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_RetryProvisioning_Post.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_Update.json new file mode 100644 index 000000000000..603df5ecdaba --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/SessionHost_Update.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2023-11-01-preview", + "force": true, + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2019-01-24T20:00:08.2893033Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/StartMenuItem_List.json new file mode 100644 index 000000000000..7b369aa32883 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/StartMenuItem_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "word", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + }, + { + "name": "application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "excel", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_Delete.json new file mode 100644 index 000000000000..dcd550642eda --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_Delete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2023-11-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_Disconnect_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_Disconnect_Post.json new file mode 100644 index 000000000000..3f93cbb16b3d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_Disconnect_Post.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_Get.json new file mode 100644 index 000000000000..3bae63f60db7 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_List.json new file mode 100644 index 000000000000..798be10cdef4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_List.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_ListByHostPool.json new file mode 100644 index 000000000000..e6ae46f52b38 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_ListByHostPool.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2023-11-01-preview", + "$filter": "userPrincipalName eq 'user1@microsoft.com' and state eq 'active'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_SendMessage_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_SendMessage_Post.json new file mode 100644 index 000000000000..447577f75ce9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/UserSession_SendMessage_Post.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2023-11-01-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Create.json new file mode 100644 index 000000000000..cb6f8bc6b669 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Create.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2023-11-01-preview", + "workspace": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Delete.json new file mode 100644 index 000000000000..64e1ee9d04fd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Delete.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + "204": {} + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Get.json new file mode 100644 index 000000000000..772fc1198a33 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_ListByResourceGroup.json new file mode 100644 index 000000000000..cd05142c8605 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_ListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_ListBySubscription.json new file mode 100644 index 000000000000..ab6f7ce7a996 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_ListBySubscription.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2023-11-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Update.json new file mode 100644 index 000000000000..e416ffd35595 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2023-11-01-preview/examples/Workspace_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2023-11-01-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/readme.md b/specification/desktopvirtualization/resource-manager/readme.md index 01c70e05e54d..a45e559605e9 100644 --- a/specification/desktopvirtualization/resource-manager/readme.md +++ b/specification/desktopvirtualization/resource-manager/readme.md @@ -26,21 +26,34 @@ These are the global settings for the DesktopVirtualizationClient API. ``` yaml openapi-type: arm -tag: package-preview-2023-10 +tag: package-preview-2023-11 ``` +### Tag: package-preview-2023-11 + +These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-11' +input-file: + - Microsoft.DesktopVirtualization/preview/2023-11-01-preview/desktopvirtualization.json +suppressions: + - code: ResourceNameRestriction + from: desktopvirtualization.json + reason: Pattern restriction will be a breaking change. Update for next stable version. Work item to fix https://microsoft.visualstudio.com/OS/_workitems/edit/47527278 +``` ### Tag: package-preview-2023-10 These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-10' +``` yaml $(tag) == 'package-preview-2023-10' input-file: - Microsoft.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json suppressions: - code: ResourceNameRestriction reason: HostPoolName, ApplicationGroupName, WorkspaceName, ScalingPlanName were already implemented in previous versions of the API and we cannot change naming pattern now. ``` + ### Tag: package-2023-09 These settings apply only when `--tag=package-2023-09` is specified on the command line. diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json index a52092f44377..e3a9ecab8bc7 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-10-01-preview/devbox.json @@ -418,6 +418,12 @@ "description": "The request was accepted.", "schema": { "$ref": "#/definitions/CustomizationTaskListValidationOperationResult" + }, + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } } }, "default": { diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-10-01-preview/environments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-10-01-preview/environments.json index 575ffa3f6f66..e1ce248beebd 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-10-01-preview/environments.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-10-01-preview/environments.json @@ -262,6 +262,9 @@ "application/merge-patch+json" ], "parameters": [ + { + "$ref": "devcenter.json#/parameters/ApiVersionParameter" + }, { "$ref": "devcenter.json#/parameters/ProjectNameParameter" }, diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GenerateAccessToken.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GenerateAccessToken.json new file mode 100644 index 000000000000..7a4d9285a003 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GenerateAccessToken.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "offerId": "0001-com-ubuntu-pro-jammy", + "resourceUri": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo", + "body": { + "deviceVersion": "1.0.18062.1", + "deviceSku": "edge", + "egeMarketPlaceResourceId": "testid", + "edgeMarketPlaceRegion": "EastUS2Euap", + "hypervGeneration": "V2", + "marketPlaceSku": "2022-datacenter-azure-edition-core", + "marketPlaceSkuVersion": "20348.1129.221007", + "publisherName": "ubuntu" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "diskId": "abcd", + "status": "created", + "accessToken": "hidden" + } + } + } +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GetAccessToken.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GetAccessToken.json new file mode 100644 index 000000000000..80c7df409aa4 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GetAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "offerId": "0001-com-ubuntu-pro-jammy", + "resourceUri": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo", + "body": { + "requestId": "1.0.18062.1" + } + }, + "responses": { + "200": { + "body": { + "diskId": "abcd", + "status": "created", + "accessToken": "hidden" + } + } + } +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GetOffer.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GetOffer.json new file mode 100644 index 000000000000..a1df6f0c2614 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GetOffer.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "offerId": "0001-com-ubuntu-pro-jammy", + "resourceUri": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo" + }, + "responses": { + "200": { + "body": { + "properties": { + "contentVersion": "1.0", + "contentUrl": "test", + "provisioningState": "Succeeded", + "offerContent": { + "displayName": "Ubuntu Pro 22.04 LTS", + "summary": "Ubuntu Pro is providing additional coverage for production environments running in the cloud.", + "longSummary": "The official Ubuntu Linux, optimized for Azure with ten years of maintenance and additional security, compliance (e.g. FIPS, CIS, DISA) and management tools.", + "description": "

Ubuntu Pro is a cross-cloud OS optimized for Azure", + "offerId": "0001-com-ubuntu-pro-jammy", + "popularity": 8, + "offerPublisher": { + "publisherId": "canonical", + "publisherDisplayName": "Canonical" + }, + "offerType": "VirtualMachine", + "availability": "Preview", + "releaseType": "Preview", + "termsAndConditions": { + "legalTermsUri": "https://query.prod.cms.rt.microsoft.com/cms/api/am/binary/RW14H4N", + "legalTermsType": "None", + "privacyPolicyUri": "http://www.ubuntu.com/aboutus/privacypolicy" + }, + "supportUri": "https://ubuntu.com/azure/support", + "categoryIds": [], + "iconFileUris": { + "small": "https://store-images.s-microsoft.com/image/apps.32072.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.42bcf340-fd72-405a-844d-7b0331419ec1", + "medium": "https://store-images.s-microsoft.com/image/apps.58881.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.31dd70ea-0671-4ad3-992b-6ce1a3f7a49e", + "wide": "https://store-images.s-microsoft.com/image/apps.17366.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.a2ff8d5b-de36-4d9c-be47-81e15b0c6f6a", + "large": "https://store-images.s-microsoft.com/image/apps.60707.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.50b643a0-de63-4ac1-88a2-d2390e2123c2" + } + }, + "marketplaceSkus": [ + { + "catalogPlanId": "canonical.0001-com-ubuntu-pro-jammypro-22_04-lts", + "marketplaceSkuId": "pro-22_04-lts", + "displayName": "pro-22_04-lts", + "type": "test", + "operatingSystem": { + "name": "linux", + "type": "test", + "family": "test" + }, + "marketplaceSkuVersions": [ + { + "name": "22.04.202204200", + "sizeOnDiskInMb": 0, + "minimumDownloadSizeInMb": 0, + "stageName": "teststage" + } + ] + } + ] + }, + "id": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo/providers/Microsoft.EdgeMarketplace/publishers/canonical/offers/0001-com-ubuntu-pro-jammy", + "name": "0001-com-ubuntu-pro-jammy", + "type": "Microsoft.EdgeMarketplace/publishers/offers" + } + } + } +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GetPublisher.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GetPublisher.json new file mode 100644 index 000000000000..f77ae06ccb86 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/GetPublisher.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceUri": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo", + "publisherName": "canonical" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo/providers/Microsoft.EdgeMarketplace/publishers/canonical", + "name": "canonical", + "type": "Microsoft.EdgeMarketplace/publishers", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListOffers.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListOffers.json new file mode 100644 index 000000000000..39d26df76dbd --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListOffers.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceUri": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "contentVersion": "1.0", + "contentUrl": "test", + "provisioningState": "Succeeded", + "offerContent": { + "displayName": "Ubuntu Pro 22.04 LTS", + "summary": "Ubuntu Pro is providing additional coverage for production environments running in the cloud.", + "longSummary": "The official Ubuntu Linux, optimized for Azure with ten years of maintenance and additional security, compliance (e.g. FIPS, CIS, DISA) and management tools.", + "description": "

Ubuntu Pro is a cross-cloud OS optimized for Azure", + "offerId": "0001-com-ubuntu-pro-jammy", + "popularity": 8, + "offerPublisher": { + "publisherId": "canonical", + "publisherDisplayName": "Canonical" + }, + "offerType": "VirtualMachine", + "availability": "Preview", + "releaseType": "Preview", + "termsAndConditions": { + "legalTermsUri": "https://query.prod.cms.rt.microsoft.com/cms/api/am/binary/RW14H4N", + "legalTermsType": "None", + "privacyPolicyUri": "http://www.ubuntu.com/aboutus/privacypolicy" + }, + "supportUri": "https://ubuntu.com/azure/support", + "categoryIds": [], + "iconFileUris": { + "small": "https://store-images.s-microsoft.com/image/apps.32072.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.42bcf340-fd72-405a-844d-7b0331419ec1", + "medium": "https://store-images.s-microsoft.com/image/apps.58881.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.31dd70ea-0671-4ad3-992b-6ce1a3f7a49e", + "wide": "https://store-images.s-microsoft.com/image/apps.17366.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.a2ff8d5b-de36-4d9c-be47-81e15b0c6f6a", + "large": "https://store-images.s-microsoft.com/image/apps.60707.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.50b643a0-de63-4ac1-88a2-d2390e2123c2" + } + }, + "marketplaceSkus": [ + { + "catalogPlanId": "canonical.0001-com-ubuntu-pro-jammypro-22_04-lts", + "marketplaceSkuId": "pro-22_04-lts", + "displayName": "pro-22_04-lts", + "type": "test", + "operatingSystem": { + "name": "linux", + "type": "test", + "family": "test" + }, + "marketplaceSkuVersions": [ + { + "name": "22.04.202204200", + "sizeOnDiskInMb": 0, + "minimumDownloadSizeInMb": 0, + "stageName": "teststage" + } + ] + } + ] + }, + "id": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo/providers/Microsoft.EdgeMarketplace/publishers/canonical/offers/0001-com-ubuntu-pro-jammy", + "name": "0001-com-ubuntu-pro-jammy", + "type": "Microsoft.EdgeMarketplace/publishers/offers" + } + ] + } + } + } +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListOffersBySubscription.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListOffersBySubscription.json new file mode 100644 index 000000000000..e281a5f99706 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListOffersBySubscription.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "subscriptionId": "4bed37fd-19a1-4d31-8b44-40267555bec5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "contentVersion": "1.0", + "contentUrl": "test", + "provisioningState": "Succeeded", + "offerContent": { + "displayName": "Ubuntu Pro 22.04 LTS", + "summary": "Ubuntu Pro is providing additional coverage for production environments running in the cloud.", + "longSummary": "The official Ubuntu Linux, optimized for Azure with ten years of maintenance and additional security, compliance (e.g. FIPS, CIS, DISA) and management tools.", + "description": "

Ubuntu Pro is a cross-cloud OS optimized for Azure", + "offerId": "0001-com-ubuntu-pro-jammy", + "popularity": 8, + "offerPublisher": { + "publisherId": "canonical", + "publisherDisplayName": "Canonical" + }, + "offerType": "VirtualMachine", + "availability": "Preview", + "releaseType": "Preview", + "termsAndConditions": { + "legalTermsUri": "https://query.prod.cms.rt.microsoft.com/cms/api/am/binary/RW14H4N", + "legalTermsType": "None", + "privacyPolicyUri": "http://www.ubuntu.com/aboutus/privacypolicy" + }, + "supportUri": "https://ubuntu.com/azure/support", + "categoryIds": [], + "iconFileUris": { + "small": "https://store-images.s-microsoft.com/image/apps.32072.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.42bcf340-fd72-405a-844d-7b0331419ec1", + "medium": "https://store-images.s-microsoft.com/image/apps.58881.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.31dd70ea-0671-4ad3-992b-6ce1a3f7a49e", + "wide": "https://store-images.s-microsoft.com/image/apps.17366.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.a2ff8d5b-de36-4d9c-be47-81e15b0c6f6a", + "large": "https://store-images.s-microsoft.com/image/apps.60707.2b66b35a-b926-4ddc-85fa-cc9d9cb874d9.77c42e2a-c945-4abb-8faa-365a38a108ed.50b643a0-de63-4ac1-88a2-d2390e2123c2" + } + }, + "marketplaceSkus": [ + { + "catalogPlanId": "canonical.0001-com-ubuntu-pro-jammypro-22_04-lts", + "marketplaceSkuId": "pro-22_04-lts", + "displayName": "pro-22_04-lts", + "type": "test", + "operatingSystem": { + "name": "linux", + "type": "test", + "family": "test" + }, + "marketplaceSkuVersions": [ + { + "name": "22.04.202204200", + "sizeOnDiskInMb": 0, + "minimumDownloadSizeInMb": 0, + "stageName": "teststage" + } + ] + } + ] + }, + "id": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo/providers/Microsoft.EdgeMarketplace/publishers/canonical/offers/0001-com-ubuntu-pro-jammy", + "name": "0001-com-ubuntu-pro-jammy", + "type": "Microsoft.EdgeMarketplace/publishers/offers" + } + ] + } + } + } +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListOperations.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListOperations.json new file mode 100644 index 000000000000..d5e85b08f9ae --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListOperations.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.EdgeMarketplace/Publishers", + "isDataAction": false, + "display": { + "provider": "Microsoft.EdgeMarketplace", + "resource": "Publishers", + "operation": "List the publishers", + "description": "Gets the list of the publishers." + } + } + ] + } + } + } +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListPublishers.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListPublishers.json new file mode 100644 index 000000000000..4716c707d7fa --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListPublishers.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "resourceUri": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo", + "filter": "deviceSku eq 'edgepro1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo/providers/Microsoft.EdgeMarketplace/publishers/canonical", + "name": "canonical", + "type": "Microsoft.EdgeMarketplace/publishers", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "id": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo/providers/Microsoft.EdgeMarketplace/publishers/ntegralinc1586961136942", + "name": "ntegralinc1586961136942", + "type": "Microsoft.EdgeMarketplace/publishers" + } + ] + } + } + } +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListPublishersBySubscription.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListPublishersBySubscription.json new file mode 100644 index 000000000000..2ded643a1440 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/examples/ListPublishersBySubscription.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-08-01", + "subscriptionId": "4bed37fd-19a1-4d31-8b44-40267555bec5", + "filter": "deviceSku eq 'edgepro1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo/providers/Microsoft.EdgeMarketplace/publishers/canonical", + "name": "canonical", + "type": "Microsoft.EdgeMarketplace/publishers", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "id": "subscriptions/4bed37fd-19a1-4d31-8b44-40267555bec5/resourceGroups/edgemarketplace-rg/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/edgemarketplace-demo/providers/Microsoft.EdgeMarketplace/publishers/ntegralinc1586961136942", + "name": "ntegralinc1586961136942", + "type": "Microsoft.EdgeMarketplace/publishers" + } + ] + } + } + } +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/offers.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/offers.json new file mode 100644 index 000000000000..9ad2124a4cd7 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/offers.json @@ -0,0 +1,853 @@ +{ + "swagger": "2.0", + "info": { + "title": "EdgeMarketplaceClient", + "version": "2023-08-01", + "description": "Edge Market Place 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": "Offers" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.EdgeMarketplace/offers": { + "get": { + "tags": [ + "Offers" + ], + "operationId": "Offers_List", + "x-ms-examples": { + "List offers": { + "$ref": "./examples/ListOffers.json" + } + }, + "description": "List Offer resources by parent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.FilterQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OfferListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeMarketplace/offers": { + "get": { + "tags": [ + "Offers" + ], + "operationId": "Offers_ListBySubscription", + "x-ms-examples": { + "List offers by subscription": { + "$ref": "./examples/ListOffersBySubscription.json" + } + }, + "description": "List Offer resources by subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.FilterQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OfferListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.EdgeMarketplace/offers/{offerId}": { + "get": { + "tags": [ + "Offers" + ], + "operationId": "Offers_Get", + "x-ms-examples": { + "Get offer": { + "$ref": "./examples/GetOffer.json" + } + }, + "description": "Get a Offer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "offerId", + "in": "path", + "required": true, + "description": "Id of the offer", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Offer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.EdgeMarketplace/offers/{offerId}/generateAccessToken": { + "post": { + "tags": [ + "Offers" + ], + "operationId": "Offers_GenerateAccessToken", + "x-ms-examples": { + "Generate AccessToken": { + "$ref": "./examples/GenerateAccessToken.json" + } + }, + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "offerId", + "in": "path", + "required": true, + "description": "Id of the offer", + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "description": "The content of the action request", + "schema": { + "$ref": "#/definitions/AccessTokenRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiskAccessToken" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + }, + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.EdgeMarketplace/offers/{offerId}/getAccessToken": { + "post": { + "tags": [ + "Offers" + ], + "operationId": "Offers_GetAccessToken", + "x-ms-examples": { + "Get AccessToken": { + "$ref": "./examples/GetAccessToken.json" + } + }, + "description": "get access token.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "offerId", + "in": "path", + "required": true, + "description": "Id of the offer", + "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "description": "The content of the action request", + "schema": { + "$ref": "#/definitions/AccessTokenReadRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiskAccessToken" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AccessTokenReadRequest": { + "type": "object", + "properties": { + "requestId": { + "type": "string", + "description": "The name of the publisher." + } + }, + "description": "Access token request object", + "required": [ + "requestId" + ] + }, + "AccessTokenRequest": { + "type": "object", + "properties": { + "publisherName": { + "type": "string", + "description": "The name of the publisher." + }, + "edgeMarketPlaceRegion": { + "type": "string", + "description": "The region where the disk will be created." + }, + "egeMarketPlaceResourceId": { + "type": "string", + "description": "The region where the disk will be created." + }, + "hypervGeneration": { + "type": "string", + "description": "The hyperv version." + }, + "marketPlaceSku": { + "type": "string", + "description": "The marketplace sku." + }, + "marketPlaceSkuVersion": { + "type": "string", + "description": "The marketplace sku version." + }, + "deviceSku": { + "type": "string", + "description": "The device sku." + }, + "deviceVersion": { + "type": "string", + "description": "The device sku version." + } + }, + "description": "Access token request object", + "required": [ + "edgeMarketPlaceRegion" + ] + }, + "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." + } + ] + } + }, + "DiskAccessToken": { + "type": "object", + "properties": { + "diskId": { + "type": "string", + "description": "The disk id." + }, + "status": { + "type": "string", + "description": "The access token creation status." + }, + "accessToken": { + "type": "string", + "description": "The access token." + } + }, + "description": "The disk access token", + "required": [ + "accessToken" + ] + }, + "IconFileUris": { + "type": "object", + "properties": { + "small": { + "type": "string", + "description": "uri of small icon" + }, + "medium": { + "type": "string", + "description": "uri of medium icon" + }, + "wide": { + "type": "string", + "description": "uri of wide icon" + }, + "large": { + "type": "string", + "description": "uri of large icon" + } + }, + "description": "Icon files" + }, + "MarketplaceSku": { + "type": "object", + "properties": { + "catalogPlanId": { + "type": "string", + "description": "The catalog plan id" + }, + "marketplaceSkuId": { + "type": "string", + "description": "The marketplace sku id" + }, + "type": { + "type": "string", + "description": "The type of marketplace sku" + }, + "displayName": { + "type": "string", + "description": "The display name of marketplace sku" + }, + "summary": { + "type": "string", + "description": "The summary" + }, + "longSummary": { + "type": "string", + "description": "The long summary" + }, + "description": { + "type": "string", + "description": "The description" + }, + "generation": { + "type": "string", + "description": "The generation" + }, + "displayRank": { + "type": "integer", + "format": "int32", + "description": "The display rank of the sku" + }, + "operatingSystem": { + "$ref": "#/definitions/SkuOperatingSystem", + "description": "The operating system supported" + }, + "marketplaceSkuVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/MarketplaceSkuVersion" + }, + "x-ms-identifiers": [], + "description": "The marketplace sku version", + "x-typespec-name": "MarketplaceSkuVersion[]" + } + }, + "description": "The marketplace sku", + "required": [ + "catalogPlanId", + "marketplaceSkuId" + ] + }, + "MarketplaceSkuVersion": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of sku version" + }, + "sizeOnDiskInMb": { + "type": "integer", + "format": "int32", + "description": "The size of the image" + }, + "minimumDownloadSizeInMb": { + "type": "integer", + "format": "int32", + "description": "The size of the download" + }, + "stageName": { + "type": "string", + "description": "The stage name" + } + }, + "description": "The marketplace sku version", + "required": [ + "name" + ] + }, + "Offer": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OfferProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "An offer.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "OfferAvailability": { + "type": "string", + "description": "Says if the offer is public/private", + "enum": [ + "Private", + "Public" + ], + "x-ms-enum": { + "name": "OfferAvailability", + "modelAsString": true, + "values": [ + { + "name": "Private", + "value": "Private", + "description": "The offer availability is private" + }, + { + "name": "Public", + "value": "Public", + "description": "The offer availability is public" + } + ] + } + }, + "OfferContent": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The display name of the offer" + }, + "summary": { + "type": "string", + "description": "The summary" + }, + "longSummary": { + "type": "string", + "description": "The long summary" + }, + "description": { + "type": "string", + "description": "The description" + }, + "offerId": { + "type": "string", + "description": "The offer id" + }, + "offerType": { + "type": "string", + "description": "The offer type" + }, + "supportUri": { + "type": "string", + "description": "The support uri" + }, + "popularity": { + "type": "integer", + "format": "int32", + "description": "The popularity of the offer" + }, + "offerPublisher": { + "$ref": "#/definitions/OfferPublisher", + "description": "The publisher of the offer" + }, + "availability": { + "$ref": "#/definitions/OfferAvailability", + "description": "The availability of the offer" + }, + "releaseType": { + "$ref": "#/definitions/OfferReleaseType", + "description": "The release type of the offer" + }, + "iconFileUris": { + "$ref": "#/definitions/IconFileUris", + "description": "The icon files" + }, + "termsAndConditions": { + "$ref": "#/definitions/TermsAndConditions", + "description": "The terms and conditions" + }, + "categoryIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The category ids ", + "x-typespec-name": "string[]" + }, + "operatingSystems": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The operating systems", + "x-typespec-name": "string[]" + } + }, + "description": "The offer content", + "required": [ + "displayName", + "offerId" + ] + }, + "OfferListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Offer" + }, + "description": "The Offer items on this page", + "x-typespec-name": "Offer[]" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + } + }, + "description": "The response of a Offer list operation.", + "required": [ + "value" + ] + }, + "OfferProperties": { + "type": "object", + "properties": { + "contentVersion": { + "type": "string", + "description": "The content version" + }, + "contentUrl": { + "type": "string", + "description": "The content url" + }, + "offerContent": { + "$ref": "#/definitions/OfferContent", + "description": "The offer content" + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "The resource provisioning state" + }, + "marketplaceSkus": { + "type": "array", + "items": { + "$ref": "#/definitions/MarketplaceSku" + }, + "x-ms-identifiers": [], + "description": "The marketplace skus", + "x-typespec-name": "MarketplaceSku[]" + } + }, + "description": "The offer properties", + "required": [ + "offerContent" + ] + }, + "OfferPublisher": { + "type": "object", + "properties": { + "publisherId": { + "type": "string", + "description": "The publisher Id" + }, + "publisherDisplayName": { + "type": "string", + "description": "The publisher name" + } + }, + "description": "The offer publisher", + "required": [ + "publisherId", + "publisherDisplayName" + ] + }, + "OfferReleaseType": { + "type": "string", + "description": "Offer release type", + "enum": [ + "Preview", + "GA" + ], + "x-ms-enum": { + "name": "OfferReleaseType", + "modelAsString": true, + "values": [ + { + "name": "Preview", + "value": "Preview", + "description": "The offer in preview" + }, + { + "name": "GA", + "value": "GA", + "description": "The offer in GA" + } + ] + } + }, + "SkuOperatingSystem": { + "type": "object", + "properties": { + "family": { + "type": "string", + "description": "The family of the operating system" + }, + "type": { + "type": "string", + "description": "The type of the operating system" + }, + "name": { + "type": "string", + "description": "The name of the operating system" + } + }, + "description": "The sku operating system", + "required": [ + "name" + ] + }, + "TermsAndConditions": { + "type": "object", + "properties": { + "legalTermsUri": { + "type": "string", + "description": "The legal terms and conditions uri" + }, + "legalTermsType": { + "type": "string", + "description": "The type of legal terms" + }, + "privacyPolicyUri": { + "type": "string", + "description": "The privacy policy uri" + } + }, + "description": "Terms and conditions" + } + }, + "parameters": { + "Azure.Core.FilterQueryParameter": { + "name": "$filter", + "in": "query", + "required": false, + "description": "Filter the result list using the given expression.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "required": false, + "description": "The maximum number of result items per page.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "required": false, + "description": "The number of result items to skip.", + "default": 0, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.TopQueryParameter": { + "name": "$top", + "in": "query", + "required": false, + "description": "The number of result items to return.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipTokenParameter": { + "name": "$skipToken", + "in": "query", + "required": false, + "description": "Skip over when retrieving results.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/operations.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/operations.json new file mode 100644 index 000000000000..d0cf488ed4bc --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/operations.json @@ -0,0 +1,86 @@ +{ + "swagger": "2.0", + "info": { + "title": "EdgeMarketplaceClient", + "version": "2023-08-01", + "description": "Edge Market Place 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.EdgeMarketplace/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/ListOperations.json" + } + }, + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/publishers.json b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/publishers.json new file mode 100644 index 000000000000..92eff9cd9626 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/Microsoft.EdgeMarketplace/stable/2023-08-01/publishers.json @@ -0,0 +1,343 @@ +{ + "swagger": "2.0", + "info": { + "title": "EdgeMarketplaceClient", + "version": "2023-08-01", + "description": "Edge Market Place 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": "Publishers" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.EdgeMarketplace/publishers": { + "get": { + "tags": [ + "Publishers" + ], + "operationId": "Publishers_List", + "x-ms-examples": { + "List publishers": { + "$ref": "./examples/ListPublishers.json" + } + }, + "description": "List Publisher resources by parent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.FilterQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PublisherListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EdgeMarketplace/publishers": { + "get": { + "tags": [ + "Publishers" + ], + "operationId": "Publishers_ListBySubscription", + "x-ms-examples": { + "List publishers by subscription": { + "$ref": "./examples/ListPublishersBySubscription.json" + } + }, + "description": "List Publisher resources in subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.FilterQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PublisherListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.EdgeMarketplace/publishers/{publisherName}": { + "get": { + "tags": [ + "Publishers" + ], + "operationId": "Publishers_Get", + "x-ms-examples": { + "Get publisher": { + "$ref": "./examples/GetPublisher.json" + } + }, + "description": "Get a Publisher", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "description": "Name of the publisher", + "pattern": "^.*$", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Publisher" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "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." + } + ] + } + }, + "Publisher": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PublisherProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "A publisher who provides offers.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PublisherListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Publisher" + }, + "description": "The Publisher items on this page", + "x-typespec-name": "Publisher[]" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + } + }, + "description": "The response of a Publisher list operation.", + "required": [ + "value" + ] + }, + "PublisherProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "The resource provisioning state" + } + }, + "description": "Publisher properties", + "required": [ + "provisioningState" + ] + } + }, + "parameters": { + "Azure.Core.FilterQueryParameter": { + "name": "$filter", + "in": "query", + "required": false, + "description": "Filter the result list using the given expression.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "required": false, + "description": "The maximum number of result items per page.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "required": false, + "description": "The number of result items to skip.", + "default": 0, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.TopQueryParameter": { + "name": "$top", + "in": "query", + "required": false, + "description": "The number of result items to return.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipTokenParameter": { + "name": "$skipToken", + "in": "query", + "required": false, + "description": "Skip over when retrieving results.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/edgemarketplace/resource-manager/readme.azureresourceschema.md b/specification/edgemarketplace/resource-manager/readme.azureresourceschema.md index b266f23d200d..141aac507e0b 100644 --- a/specification/edgemarketplace/resource-manager/readme.azureresourceschema.md +++ b/specification/edgemarketplace/resource-manager/readme.azureresourceschema.md @@ -6,13 +6,13 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: - - tag: package-2023-08-01-preview + - tag: package-2023-08-01 ``` Please also specify `--azureresourceschema-folder=`. -### Tag: package-2023-08-01-preview and azureresourceschema +### Tag: package-2023-08-01 and azureresourceschema -``` yaml $(tag) == '2023-08-01-preview' && $(azureresourceschema) +``` yaml $(tag) == '2023-08-01' && $(azureresourceschema) output-folder: $(azureresourceschema-folder)/schemas \ No newline at end of file diff --git a/specification/edgemarketplace/resource-manager/readme.cli.md b/specification/edgemarketplace/resource-manager/readme.cli.md new file mode 100644 index 000000000000..179636a56760 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/readme.cli.md @@ -0,0 +1,4 @@ +``` yaml +# add any configuration here for all CLI languages +# refer to the faq.md for more details +``` \ No newline at end of file diff --git a/specification/edgemarketplace/resource-manager/readme.java.md b/specification/edgemarketplace/resource-manager/readme.java.md index 97621ad7b24e..545dacee55fc 100644 --- a/specification/edgemarketplace/resource-manager/readme.java.md +++ b/specification/edgemarketplace/resource-manager/readme.java.md @@ -32,18 +32,18 @@ directive: ``` yaml $(java) && $(multiapi) batch: - - tag: package-2023-08-preview + - tag: package-2023-08 ``` -### Tag: package-2023-08-preview and java +### Tag: package-2023-08 and java -These settings apply only when `--tag=package-2023-08-preview --java` is specified on the command line. +These settings apply only when `--tag=package-2023-08 --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-2023-08-preview' && $(java) && $(multiapi) +``` yaml $(tag) == 'package-2023-08' && $(java) && $(multiapi) java: - namespace: com.microsoft.azure.management.edgemarketplace.v2023_08_01_preview - output-folder: $(azure-libraries-for-java-folder)/sdk/edgemarketplace/mgmt-v2023_08_01_preview + namespace: com.microsoft.azure.management.edgemarketplace.v2023_08_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/edgemarketplace/mgmt-v2023_08_01 regenerate-manager: true generate-interface: true -``` \ No newline at end of file +``` diff --git a/specification/edgemarketplace/resource-manager/readme.md b/specification/edgemarketplace/resource-manager/readme.md index a38a9a267689..c1af3dc628a0 100644 --- a/specification/edgemarketplace/resource-manager/readme.md +++ b/specification/edgemarketplace/resource-manager/readme.md @@ -29,19 +29,31 @@ title: EdgeMarketplaceClient description: Edge marketplace extensions openapi-type: arm openapi-subtype: rpaas -tag: package-2023-08-preview +tag: package-2023-08-01 ``` -### Tag: package-2023-08-preview -These settings apply only when `--tag=package-2023-08-preview` is specified on the command line. +### Tag: package-2023-08-01-preview -```yaml $(tag) == 'package-2023-08-preview' +These settings apply only when `--tag=package-2023-08-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-08-01-preview' input-file: - Microsoft.EdgeMarketplace/preview/2023-08-01-preview/publishers.json - Microsoft.EdgeMarketplace/preview/2023-08-01-preview/operations.json - Microsoft.EdgeMarketplace/preview/2023-08-01-preview/offers.json ``` +### Tag: package-2023-08-01 + +These settings apply only when `--tag=package-2023-08-01` is specified on the command line. + +```yaml $(tag) == 'package-2023-08-01' +input-file: + - Microsoft.EdgeMarketplace/stable/2023-08-01/publishers.json + - Microsoft.EdgeMarketplace/stable/2023-08-01/operations.json + - Microsoft.EdgeMarketplace/stable/2023-08-01/offers.json +``` + --- # Code Generation @@ -79,4 +91,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/edgemarketplace/resource-manager/readme.python.md b/specification/edgemarketplace/resource-manager/readme.python.md index d00659094582..4a654882802d 100644 --- a/specification/edgemarketplace/resource-manager/readme.python.md +++ b/specification/edgemarketplace/resource-manager/readme.python.md @@ -1,35 +1,19 @@ -f## Python +## Python These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. ```yaml $(python) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.edgemarketplace - package-name: azure-mgmt-edgemarketplace - package-version: 2023-08-01-preview - clear-output-folder: true +title: EdgeMarketPlaceMgmtClient +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +namespace: azure.mgmt.edgemarketplace +package-name: azure-mgmt-edgemarketplace +package-version: 1.0.0b1 +clear-output-folder: true ``` -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) && $(multiapi) -batch: - - tag: package-2023-08-01-preview -``` - -### Tag: package-2023-08-01-preview and python - -These settings apply only when `--tag=package-2023-08-01-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2023-08-01-preview' && $(python) -python: - namespace: azure.mgmt.edgemarketplace.v2023_08_01_preview - output-folder: $(python-sdks-folder)/edgemarketplace/azure-mgmt-edgemarketplace/azure/mgmt/edgemarketplace/v2023_08_01_preview +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/edgemarketplace/azure-mgmt-edgemarketplace/azure/mgmt/edgemarketplace ``` diff --git a/specification/edgemarketplace/resource-manager/readme.ruby.md b/specification/edgemarketplace/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..06b501a94a51 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_edgemarketplace +package-version: 2023-08-01 +azure-arm: true +``` + +### Tag: package-2023-08-01 and ruby + +These settings apply only when `--tag=package-2023-08-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2023-08-01' && $(ruby) +namespace: Microsoft.EdgeMarketplace +output-folder: $(ruby-sdks-folder)/edgemarketplace +``` diff --git a/specification/edgemarketplace/resource-manager/readme.typescript.md b/specification/edgemarketplace/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..3149f1ecff39 --- /dev/null +++ b/specification/edgemarketplace/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "edgemarketplace" + output-folder: "$(typescript-sdks-folder)/packages/edgemarketplace" + payload-flattening-threshold: 1 + generate-metadata: true +``` diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/elastic.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/elastic.json new file mode 100644 index 000000000000..712f8383bca4 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/elastic.json @@ -0,0 +1,2793 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Elastic", + "version": "2023-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Microsoft Entra ID OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Elastic/operations": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all operations provided by Microsoft.Elastic.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified subscription.", + "operationId": "Monitors_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_List": { + "$ref": "./examples/Monitors_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/elasticVersions": { + "get": { + "tags": [ + "ElasticVersions" + ], + "summary": "Get a list of available versions for a region.", + "operationId": "ElasticVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "query", + "name": "region", + "description": "Region where elastic deployment will take place.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticVersionsListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticVersions_List": { + "$ref": "./examples/ElasticVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified resource group.", + "operationId": "Monitors_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup": { + "$ref": "./examples/Monitors_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "Get the properties of a specific monitor resource.", + "operationId": "Monitors_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get": { + "$ref": "./examples/Monitors_Get.json" + } + } + }, + "put": { + "tags": [ + "MonitorsResource" + ], + "summary": "Create a monitor resource.", + "operationId": "Monitors_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic monitor resource model", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Monitors_Create": { + "$ref": "./examples/Monitors_Create.json" + } + } + }, + "patch": { + "tags": [ + "MonitorsResource" + ], + "summary": "Update a monitor resource.", + "operationId": "Monitors_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic resource model update parameters.", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Update": { + "$ref": "./examples/Monitors_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitorsResource" + ], + "summary": "Delete a monitor resource.", + "operationId": "Monitors_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_Delete": { + "$ref": "./examples/Monitors_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listMonitoredResources": { + "post": { + "tags": [ + "MonitoredResources" + ], + "summary": "List the resources currently being monitored by the Elastic monitor resource.", + "operationId": "MonitoredResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MonitoredResources_List": { + "$ref": "./examples/MonitoredResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listDeploymentInfo": { + "post": { + "tags": [ + "DeploymentInfo" + ], + "summary": "Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource.", + "operationId": "DeploymentInfo_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "DeploymentInfo_List": { + "$ref": "./examples/DeploymentInfo_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createOrUpdateExternalUser": { + "post": { + "tags": [ + "DeploymentInfo" + ], + "summary": "Create User inside elastic deployment which are used by customers to perform operations on the elastic deployment", + "operationId": "ExternalUser_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic External User Creation Parameters", + "schema": { + "$ref": "#/definitions/ExternalUserInfo" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExternalUserCreationResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalUser_CreateOrUpdate": { + "$ref": "./examples/ExternalUserInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/getBillingInfo": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "Get marketplace and organization info mapped to the given monitor.", + "operationId": "BillingInfo_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listConnectedPartnerResources": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "List of all active deployments that are associated with the marketplace subscription linked to the given monitor.", + "operationId": "ConnectedPartnerResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ConnectedPartnerResourcesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConnectedPartnerResources_List": { + "$ref": "./examples/ConnectedPartnerResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules": { + "get": { + "tags": [ + "Rules" + ], + "summary": "List the tag rules for a given monitor resource.", + "operationId": "TagRules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRulesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_List": { + "$ref": "./examples/TagRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules/{ruleSetName}": { + "put": { + "tags": [ + "Rules" + ], + "summary": "Create or update a tag rule set for a given monitor resource.", + "operationId": "TagRules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + }, + { + "description": "request body of MonitoringTagRules", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate": { + "$ref": "./examples/TagRules_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Rules" + ], + "summary": "Get a tag rule set for a given monitor resource.", + "operationId": "TagRules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get": { + "$ref": "./examples/TagRules_Get.json" + } + } + }, + "delete": { + "tags": [ + "Rules" + ], + "summary": "Delete a tag rule set for a given monitor resource.", + "operationId": "TagRules_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TagRules_Delete": { + "$ref": "./examples/TagRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listVMHost": { + "post": { + "tags": [ + "VMHHostList" + ], + "summary": "List the vm resources currently being monitored by the Elastic monitor resource.", + "operationId": "VMHost_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/VMHostListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VMHost_List": { + "$ref": "./examples/VMHost_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmIngestionDetails": { + "post": { + "tags": [ + "VMIngestionDetails" + ], + "summary": "List the vm ingestion details that will be monitored by the Elastic monitor resource.", + "operationId": "VMIngestion_Details", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/VMIngestionDetailsResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VMIngestion_Details": { + "$ref": "./examples/VMIngestion_Details.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmCollectionUpdate": { + "post": { + "tags": [ + "VMCollectionUpdate" + ], + "summary": "Update the vm details that will be monitored by the Elastic monitor resource.", + "operationId": "VMCollection_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "VM resource Id", + "schema": { + "$ref": "#/definitions/VMCollectionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VMCollection_Update": { + "$ref": "./examples/VMCollection_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listUpgradableVersions": { + "post": { + "tags": [ + "MonitorUpgradableVersions" + ], + "summary": "List of upgradable versions for a given monitor resource.", + "operationId": "UpgradableVersions_Details", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UpgradableVersionsList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "UpgradableVersions_Details": { + "$ref": "./examples/UpgradableVersions_Details.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/upgrade": { + "post": { + "tags": [ + "DeploymentUpdate" + ], + "summary": "Upgradable version for a monitor resource.", + "operationId": "Monitor_Upgrade", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic Monitor Upgrade Parameters", + "schema": { + "$ref": "#/definitions/ElasticMonitorUpgrade" + } + } + ], + "responses": { + "202": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitor_Upgrade": { + "$ref": "./examples/Monitor_Upgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAllTrafficFilters": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Get the list of all traffic filters for the account.", + "operationId": "AllTrafficFilters_list", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticTrafficFilterResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "AllTrafficFilters_list": { + "$ref": "./examples/AllTrafficFilters_list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAssociatedTrafficFilters": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Get the list of all associated traffic filters for the given deployment.", + "operationId": "listAssociatedTrafficFilters_list", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticTrafficFilterResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "listAssociatedTrafficFilters_list": { + "$ref": "./examples/AssociatedFiltersForDeployment_list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociateIPFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Create and Associate IP traffic filter for the given deployment.", + "operationId": "createAndAssociateIPFilter_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "ips", + "description": "List of ips", + "type": "string" + }, + { + "in": "query", + "name": "name", + "description": "Name of the traffic filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "createAndAssociateIPFilter_Create": { + "$ref": "./examples/IPTrafficFilter_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociatePLFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Create and Associate private link traffic filter for the given deployment.", + "operationId": "createAndAssociatePLFilter_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "name", + "description": "Name of the traffic filter", + "type": "string" + }, + { + "in": "query", + "name": "privateEndpointGuid", + "description": "Guid of the private endpoint", + "type": "string" + }, + { + "in": "query", + "name": "privateEndpointName", + "description": "Name of the private endpoint", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "createAndAssociatePLFilter_Create": { + "$ref": "./examples/PrivateLinkTrafficFilters_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/associateTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Associate traffic filter for the given deployment.", + "operationId": "AssociateTrafficFilter_Associate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "AssociateTrafficFilter_Associate": { + "$ref": "./examples/AssociateTrafficFilter_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachAndDeleteTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Detach and Delete traffic filter from the given deployment.", + "operationId": "DetachAndDeleteTrafficFilter_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "DetachAndDeleteTrafficFilter_Delete": { + "$ref": "./examples/DetachAndDeleteTrafficFilter_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Detach traffic filter for the given deployment.", + "operationId": "DetachTrafficFilter_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "DetachTrafficFilter_Update": { + "$ref": "./examples/DetachTrafficFilters_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/deleteTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Delete traffic filter from the account.", + "operationId": "TrafficFilters_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TrafficFilters_Delete": { + "$ref": "./examples/TrafficFilters_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getOrganizationApiKey": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.", + "description": "Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.", + "operationId": "Organizations_GetApiKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "body", + "name": "body", + "description": "Email Id parameter of the User Organization, of which the API Key must be returned", + "schema": { + "$ref": "#/definitions/UserEmailId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UserApiKeyResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_GetApiKey": { + "$ref": "./examples/Organizations_GetApiKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getElasticOrganizationToAzureSubscriptionMapping": { + "post": { + "tags": [ + "UserOrganization" + ], + "summary": "Get Elastic Organization To Azure Subscription Mapping details for the logged-in user.", + "description": "Get Elastic Organization To Azure Subscription Mapping details for the logged-in user.", + "operationId": "Organizations_GetElasticToAzureSubscriptionMapping", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticOrganizationToAzureSubscriptionMappingResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_GetElasticToAzureSubscriptionMapping": { + "$ref": "./examples/Organizations_GetElasticToAzureSubscriptionMapping.json" + } + } + } + } + }, + "definitions": { + "ErrorResponseBody": { + "description": "Error response body.", + "title": "ErrorResponseBody", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "target": { + "description": "Error target.", + "type": "string" + }, + "details": { + "description": "Error details.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + } + }, + "ResourceProviderDefaultErrorResponse": { + "description": "RP default error response.", + "type": "object", + "properties": { + "error": { + "description": "Response body of Error", + "readOnly": true, + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider, i.e., Microsoft.Elastic.", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'monitors'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write monitors'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A Microsoft.Elastic REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name, i.e., {provider}/{resource}/{operation}.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list the Microsoft.Elastic operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the Microsoft.Elastic provider.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "ResourceSku": { + "description": "Microsoft.Elastic SKU.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the SKU.", + "type": "string" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "description": "Provisioning state of Elastic resource.", + "title": "ProvisioningState", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "MonitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MonitoringStatus" + } + }, + "ElasticCloudUser": { + "description": "Details of the user's elastic account.", + "type": "object", + "properties": { + "emailAddress": { + "description": "Email of the Elastic User Account.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "User Id of the elastic account of the User.", + "type": "string", + "readOnly": true + }, + "elasticCloudSsoDefaultUrl": { + "description": "Elastic cloud default dashboard sso URL of the Elastic user account.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticCloudDeployment": { + "description": "Details of the user's elastic deployment associated with the monitor resource.", + "type": "object", + "properties": { + "name": { + "description": "Elastic deployment name", + "type": "string", + "readOnly": true + }, + "deploymentId": { + "description": "Elastic deployment Id", + "type": "string", + "readOnly": true + }, + "azureSubscriptionId": { + "description": "Associated Azure subscription Id for the elastic deployment.", + "type": "string", + "readOnly": true + }, + "elasticsearchRegion": { + "description": "Region where Deployment at Elastic side took place.", + "type": "string", + "readOnly": true + }, + "elasticsearchServiceUrl": { + "description": "Elasticsearch ingestion endpoint of the Elastic deployment.", + "type": "string", + "readOnly": true + }, + "kibanaServiceUrl": { + "description": "Kibana endpoint of the Elastic deployment.", + "type": "string", + "readOnly": true + }, + "kibanaSsoUrl": { + "description": "Kibana dashboard sso URL of the Elastic deployment.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticProperties": { + "description": "Elastic Resource Properties.", + "type": "object", + "properties": { + "elasticCloudUser": { + "description": "Details of the user's elastic account.", + "$ref": "#/definitions/ElasticCloudUser" + }, + "elasticCloudDeployment": { + "description": "Details of the elastic cloud deployment.", + "$ref": "#/definitions/ElasticCloudDeployment" + } + } + }, + "CompanyInfo": { + "description": "Company information of the user to be passed to partners.", + "type": "object", + "properties": { + "domain": { + "description": "Domain of the company", + "maxLength": 250, + "type": "string" + }, + "business": { + "description": "Business of the company", + "maxLength": 64, + "type": "string" + }, + "employeesNumber": { + "description": "Number of employees in the company", + "maxLength": 20, + "type": "string" + }, + "state": { + "description": "State of the company location.", + "maxLength": 64, + "type": "string" + }, + "country": { + "description": "Country of the company location.", + "maxLength": 64, + "type": "string" + } + } + }, + "UserInfo": { + "description": "User Information to be passed to partners.", + "type": "object", + "properties": { + "firstName": { + "description": "First name of the user", + "maxLength": 50, + "type": "string" + }, + "lastName": { + "description": "Last name of the user", + "maxLength": 50, + "type": "string" + }, + "companyName": { + "description": "Company name of the user", + "maxLength": 64, + "type": "string" + }, + "emailAddress": { + "description": "Email of the user used by Elastic for contacting them if needed", + "pattern": "^([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)@(([a-zA-Z-_0-9]+\\.)+[a-zA-Z]{2,})$", + "type": "string" + }, + "companyInfo": { + "description": "Company information of the user to be passed to partners.", + "$ref": "#/definitions/CompanyInfo" + } + } + }, + "PlanDetails": { + "description": "Plan details of the monitor resource.", + "type": "object", + "properties": { + "offerID": { + "description": "Offer ID of the plan", + "type": "string" + }, + "publisherID": { + "description": "Publisher ID of the plan", + "type": "string" + }, + "termID": { + "description": "Term ID of the plan", + "type": "string" + }, + "planID": { + "description": "Plan ID", + "type": "string" + }, + "planName": { + "description": "Plan Name", + "type": "string" + } + } + }, + "LiftrResourceCategories": { + "enum": [ + "Unknown", + "MonitorLogs" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "LiftrResourceCategories" + }, + "readOnly": true + }, + "MonitorProperties": { + "description": "Properties specific to the monitor resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the monitor resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "monitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "$ref": "#/definitions/MonitoringStatus" + }, + "elasticProperties": { + "description": "Elastic cloud properties.", + "$ref": "#/definitions/ElasticProperties" + }, + "userInfo": { + "description": "User information.", + "$ref": "#/definitions/UserInfo", + "x-ms-mutability": [ + "create" + ] + }, + "planDetails": { + "description": "Plan details of the monitor resource.", + "$ref": "#/definitions/PlanDetails" + }, + "version": { + "description": "Version of elastic of the monitor resource", + "type": "string" + }, + "saaSAzureSubscriptionStatus": { + "description": "Status of Azure Subscription where Marketplace SaaS is located.", + "type": "string" + }, + "sourceCampaignName": { + "description": "Name of the marketing campaign.", + "type": "string" + }, + "sourceCampaignId": { + "description": "A unique identifier associated with the campaign.", + "type": "string" + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories" + }, + "liftrResourcePreference": { + "description": "The priority of the resource.", + "format": "int32", + "type": "integer", + "readOnly": true + }, + "generateApiKey": { + "description": "Flag to determine if User API Key has to be generated and shared.", + "type": "boolean" + } + } + }, + "ManagedIdentityTypes": { + "enum": [ + "SystemAssigned" + ], + "type": "string", + "description": "Managed Identity types.", + "x-ms-enum": { + "modelAsString": true, + "name": "ManagedIdentityTypes" + } + }, + "IdentityProperties": { + "description": "Identity properties.", + "type": "object", + "properties": { + "principalId": { + "description": "The identity ID.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Managed identity type.", + "$ref": "#/definitions/ManagedIdentityTypes" + } + } + }, + "ElasticMonitorResource": { + "description": "Monitor resource.", + "required": [ + "location" + ], + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the monitor resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the monitor resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitor resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "SKU of the monitor resource.", + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "description": "Properties of the monitor resource.", + "$ref": "#/definitions/MonitorProperties", + "x-ms-client-flatten": false + }, + "identity": { + "description": "Identity properties of the monitor resource.", + "$ref": "#/definitions/IdentityProperties" + }, + "tags": { + "description": "The tags of the monitor resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "description": "The location of the monitor resource", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + } + }, + "ElasticMonitorResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ElasticMonitorResourceUpdateParameters": { + "description": "Monitor resource update parameters.", + "type": "object", + "properties": { + "tags": { + "description": "elastic monitor resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SendingLogs": { + "enum": [ + "True", + "False" + ], + "type": "string", + "description": "Flag indicating the status of the resource for sending logs operation to Elastic.", + "title": "SendingLogs", + "x-ms-enum": { + "modelAsString": true, + "name": "SendingLogs" + } + }, + "MonitoredResource": { + "description": "The properties of a resource currently being monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the resource.", + "type": "string" + }, + "sendingLogs": { + "description": "Flag indicating the status of the resource for sending logs operation to Elastic.", + "$ref": "#/definitions/SendingLogs" + }, + "reasonForLogsStatus": { + "description": "Reason for why the resource is sending logs (or why it is not sending).", + "type": "string" + } + } + }, + "MonitoredResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MonitoredResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "TagAction": { + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TagAction" + } + }, + "FilteringTag": { + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.", + "type": "object", + "properties": { + "name": { + "description": "The name (also known as the key) of the tag.", + "type": "string" + }, + "value": { + "description": "The value of the tag.", + "type": "string" + }, + "action": { + "description": "Valid actions for a filtering tag.", + "$ref": "#/definitions/TagAction" + } + } + }, + "ElasticVersionListFormat": { + "description": "Elastic Version List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticVersionListProperties" + } + } + }, + "ElasticVersionListProperties": { + "description": "Elastic Version Properties", + "type": "object", + "properties": { + "version": { + "description": "Available elastic version of the given region", + "type": "string" + } + } + }, + "ElasticVersionsListResponse": { + "description": "List of elastic versions available in a region.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [ + "properties/version" + ], + "items": { + "$ref": "#/definitions/ElasticVersionListFormat" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "LogRules": { + "description": "Set of rules for sending logs for the Monitor resource.", + "type": "object", + "properties": { + "sendAadLogs": { + "description": "Flag specifying if AAD logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendSubscriptionLogs": { + "description": "Flag specifying if subscription logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendActivityLogs": { + "description": "Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.", + "type": "boolean" + }, + "filteringTags": { + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "MonitoringTagRulesProperties": { + "description": "Definition of the properties for a TagRules resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the monitoring tag rules.", + "$ref": "#/definitions/ProvisioningState" + }, + "logRules": { + "description": "Rules for sending logs.", + "$ref": "#/definitions/LogRules" + } + } + }, + "MonitoringTagRules": { + "description": "Capture logs and metrics of Azure resources based on ARM tags.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the rule set.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the rule set.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the rule set.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the monitoring tag rules.", + "$ref": "#/definitions/MonitoringTagRulesProperties", + "x-ms-client-flatten": false + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + } + }, + "MonitoringTagRulesListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "BillingInfoResponse": { + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "type": "object", + "properties": { + "marketplaceSaasInfo": { + "description": "Marketplace Subscription details", + "$ref": "#/definitions/MarketplaceSaaSInfo" + }, + "partnerBillingEntity": { + "description": "Partner Billing Entity details: Organization Info", + "$ref": "#/definitions/PartnerBillingEntity" + } + } + }, + "MarketplaceSaaSInfo": { + "description": "Marketplace SAAS Info of the resource.", + "type": "object", + "properties": { + "marketplaceSubscription": { + "description": "Marketplace Subscription", + "type": "object", + "properties": { + "id": { + "description": "Marketplace Subscription Id. This is a GUID-formatted string.", + "type": "string" + } + } + }, + "marketplaceName": { + "description": "Marketplace Subscription Details: SAAS Name", + "type": "string" + }, + "marketplaceResourceId": { + "description": "Marketplace Subscription Details: Resource URI", + "type": "string" + }, + "marketplaceStatus": { + "description": "Marketplace Subscription Details: SaaS Subscription Status", + "type": "string" + }, + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", + "type": "string" + }, + "subscribed": { + "description": "Flag specifying if the Marketplace status is subscribed or not.", + "type": "boolean" + } + } + }, + "PartnerBillingEntity": { + "description": "Partner Billing details associated with the resource.", + "type": "object", + "properties": { + "id": { + "description": "The Elastic Organization Id.", + "type": "string" + }, + "name": { + "description": "The Elastic Organization Name.", + "type": "string" + }, + "partnerEntityUri": { + "description": "Link to the elastic organization page", + "type": "string" + } + } + }, + "ConnectedPartnerResourceProperties": { + "description": "Connected Partner Resource Properties", + "type": "object", + "properties": { + "partnerDeploymentName": { + "description": "Elastic deployment name", + "type": "string" + }, + "partnerDeploymentUri": { + "description": "Deployment URL of the elasticsearch in Elastic cloud deployment.", + "type": "string" + }, + "azureResourceId": { + "description": "The azure resource Id of the deployment.", + "type": "string" + }, + "location": { + "description": "The location of the deployment.", + "type": "string" + } + } + }, + "ConnectedPartnerResourcesListFormat": { + "description": "Connected Partner Resources List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedPartnerResourceProperties" + } + } + }, + "ConnectedPartnerResourcesListResponse": { + "description": " List of all active elastic deployments.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [ + "properties/azureResourceId" + ], + "items": { + "$ref": "#/definitions/ConnectedPartnerResourcesListFormat" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ElasticDeploymentStatus": { + "description": "Flag specifying if the Elastic deployment status is healthy or not.", + "enum": [ + "Healthy", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ElasticDeploymentStatus" + } + }, + "DeploymentInfoResponse": { + "description": "The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.", + "type": "object", + "properties": { + "status": { + "description": "The Elastic deployment status.", + "$ref": "#/definitions/ElasticDeploymentStatus", + "readOnly": true + }, + "version": { + "description": "Version of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "memoryCapacity": { + "description": "RAM capacity of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "diskCapacity": { + "description": "Disk capacity of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "elasticsearchEndPoint": { + "description": "Elasticsearch endpoint in Elastic cloud deployment. This is either the aliased_endpoint if available, or the service_url otherwise.", + "type": "string", + "readOnly": true + }, + "deploymentUrl": { + "description": "Deployment URL of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "marketplaceSaasInfo": { + "description": "Marketplace SaaS Info of the resource.", + "$ref": "#/definitions/MarketplaceSaaSInfo", + "readOnly": true + } + } + }, + "ExternalUserCreationResponse": { + "description": "The properties of the response we got from elastic while creating external user", + "type": "object", + "properties": { + "created": { + "description": "Shows if user is created or updated", + "type": "boolean", + "readOnly": true + } + } + }, + "ExternalUserInfo": { + "description": "The properties of the request required for creating user on elastic side", + "type": "object", + "properties": { + "userName": { + "description": "Username of the user to be created or updated", + "type": "string" + }, + "fullName": { + "description": "Full name of the user to be created or updated", + "type": "string" + }, + "password": { + "x-ms-secret": true, + "description": "Password of the user to be created or updated", + "type": "string" + }, + "emailId": { + "description": "Email id of the user to be created or updated", + "type": "string" + }, + "roles": { + "description": "Roles to be assigned for created or updated user", + "type": "array", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "VMHostListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/VMResources" + } + }, + "nextLink": { + "description": "Link to the next Vm resource Id, if any.", + "type": "string" + } + } + }, + "VMResources": { + "description": "The vm resource properties that is currently being monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "vmResourceId": { + "description": "The ARM id of the VM resource.", + "type": "string" + } + } + }, + "VMIngestionDetailsResponse": { + "description": "The vm ingestion details to install an agent.", + "type": "object", + "properties": { + "cloudId": { + "description": "The cloudId of given Elastic monitor resource.", + "type": "string" + }, + "ingestionKey": { + "description": "Ingestion details to install agent on given VM.", + "type": "string", + "x-ms-secret": true + } + } + }, + "OperationName": { + "enum": [ + "Add", + "Delete" + ], + "type": "string", + "description": "Operation to be performed on the given vm resource id.", + "title": "OperationName", + "x-ms-enum": { + "modelAsString": true, + "name": "OperationName" + } + }, + "VMCollectionUpdate": { + "description": "Update VM resource collection.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "vmResourceId": { + "description": "ARM id of the VM resource.", + "type": "string" + }, + "operationName": { + "description": "Operation to be performed for given VM.", + "$ref": "#/definitions/OperationName" + } + } + }, + "UpgradableVersionsList": { + "description": "Stack Versions that this version can upgrade to", + "type": "object", + "properties": { + "currentVersion": { + "type": "string", + "description": "Current version of the elastic monitor" + }, + "upgradableVersions": { + "type": "array", + "x-ms-identifiers": [], + "description": "Stack Versions that this version can upgrade to", + "items": { + "type": "string" + } + } + } + }, + "ElasticTrafficFilterResponse": { + "description": "List of elastic traffic filters in the account", + "type": "object", + "properties": { + "rulesets": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of elastic traffic filters in the account", + "items": { + "$ref": "#/definitions/ElasticTrafficFilter" + } + } + } + }, + "ElasticTrafficFilter": { + "description": "Elastic traffic filter object", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the elastic filter" + }, + "name": { + "type": "string", + "description": "Name of the elastic filter" + }, + "description": { + "type": "string", + "description": "Description of the elastic filter" + }, + "region": { + "type": "string", + "description": "Region of the elastic filter" + }, + "type": { + "enum": [ + "ip", + "azure_private_endpoint" + ], + "type": "string", + "description": "Type of the elastic filter", + "x-ms-enum": { + "modelAsString": true, + "name": "type" + } + }, + "includeByDefault": { + "type": "boolean", + "description": "IncludeByDefault for the elastic filter" + }, + "rules": { + "type": "array", + "description": "Rules in the elastic filter", + "items": { + "$ref": "#/definitions/ElasticTrafficFilterRule" + } + } + } + }, + "ElasticTrafficFilterRule": { + "description": "Elastic traffic filter rule object", + "type": "object", + "properties": { + "source": { + "type": "string", + "description": "IP of the elastic filter rule" + }, + "description": { + "type": "string", + "description": "Description of the elastic filter rule" + }, + "azureEndpointGuid": { + "type": "string", + "description": "Guid of Private Endpoint in the elastic filter rule" + }, + "azureEndpointName": { + "type": "string", + "description": "Name of the Private Endpoint in the elastic filter rule" + }, + "id": { + "type": "string", + "description": "Id of the elastic filter rule" + } + } + }, + "ElasticMonitorUpgrade": { + "description": "Upgrade elastic monitor version", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Version to which the elastic monitor should be upgraded to" + } + } + }, + "UserEmailId": { + "description": "Email Id of the User Organization, of which the API Key must be returned", + "type": "object", + "properties": { + "emailId": { + "type": "string", + "description": "The User email Id" + } + } + }, + "UserApiKeyResponse": { + "description": "The User Api Key created for the Organization associated with the User Email Id that was passed in the request", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UserApiKeyResponseProperties" + } + } + }, + "UserApiKeyResponseProperties": { + "type": "object", + "properties": { + "apiKey": { + "description": "The User Api Key Generated based on GenerateApiKey flag. This is applicable for non-Portal clients only.", + "type": "string", + "x-ms-secret": true + } + } + }, + "ElasticOrganizationToAzureSubscriptionMappingResponse": { + "description": "The Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticOrganizationToAzureSubscriptionMappingResponseProperties" + } + } + }, + "ElasticOrganizationToAzureSubscriptionMappingResponseProperties": { + "description": "The properties of Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.", + "type": "object", + "properties": { + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Organization belongs and gets billed into. This is empty for a new user OR a user without an Elastic Organization.", + "type": "string" + }, + "marketplaceSaasInfo": { + "description": "Marketplace SaaS Info of the resource.", + "$ref": "#/definitions/MarketplaceSaaSInfo", + "readOnly": true + }, + "elasticOrganizationId": { + "description": "The Elastic Organization Id.", + "type": "string" + }, + "elasticOrganizationName": { + "description": "The Elastic Organization Name.", + "type": "string" + } + } + } + }, + "parameters": { + "MonitorNameParameter": { + "in": "path", + "name": "monitorName", + "description": "Monitor resource name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleSetNameParameter": { + "in": "path", + "name": "ruleSetName", + "description": "Tag Rule Set resource name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/AllTrafficFilters_list.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/AllTrafficFilters_list.json new file mode 100644 index 000000000000..9c2938a2997a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/AllTrafficFilters_list.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "rulesets": [ + { + "id": "31d91b5afb6f4c2eaaf104c97b1991dd", + "name": "IPFromApi", + "description": "created from azure", + "type": "ip", + "includeByDefault": false, + "region": "azure-eastus", + "rules": [ + { + "id": "f0297dad72af4a5e964cddf817f35e65", + "description": "Allow inbound traffic from IP address 192.168.131.0", + "source": "192.168.131.0" + }, + { + "id": "f9c00169f0e54931ae72aabde326b589", + "description": "Allow inbound traffic from IP address block 192.168.132.6/22", + "source": "192.168.132.6/22" + } + ] + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/AssociateTrafficFilter_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/AssociateTrafficFilter_Update.json new file mode 100644 index 000000000000..b83871b7db40 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/AssociateTrafficFilter_Update.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/associateTrafficFilter?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/AssociatedFiltersForDeployment_list.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/AssociatedFiltersForDeployment_list.json new file mode 100644 index 000000000000..9c2938a2997a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/AssociatedFiltersForDeployment_list.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "rulesets": [ + { + "id": "31d91b5afb6f4c2eaaf104c97b1991dd", + "name": "IPFromApi", + "description": "created from azure", + "type": "ip", + "includeByDefault": false, + "region": "azure-eastus", + "rules": [ + { + "id": "f0297dad72af4a5e964cddf817f35e65", + "description": "Allow inbound traffic from IP address 192.168.131.0", + "source": "192.168.131.0" + }, + { + "id": "f9c00169f0e54931ae72aabde326b589", + "description": "Allow inbound traffic from IP address block 192.168.132.6/22", + "source": "192.168.132.6/22" + } + ] + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/BillingInfo_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..110429fd4719 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/BillingInfo_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "subscribed": true + }, + "partnerBillingEntity": { + "id": "1234567890", + "name": "elasticOrganizationName", + "partnerEntityUri": "https://example.com" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/ConnectedPartnerResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/ConnectedPartnerResources_List.json new file mode 100644 index 000000000000..020a5c31cdac --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/ConnectedPartnerResources_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "partnerDeploymentName": "deploymentname", + "partnerDeploymentUri": "https://examplessourl.com", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US 2" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/DeploymentInfo_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/DeploymentInfo_List.json new file mode 100644 index 000000000000..c0137f926829 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/DeploymentInfo_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "status": "Healthy", + "version": "7.9.3", + "memoryCapacity": "1024", + "diskCapacity": "245760", + "elasticsearchEndPoint": "alias.es.eastus2.staging.azure.foundit.no", + "deploymentUrl": "https://endpoint.eastus.kb.azure.elastic-cloud.com:9243", + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json new file mode 100644 index 000000000000..317beba0bc4f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/DetachTrafficFilters_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/DetachTrafficFilters_Update.json new file mode 100644 index 000000000000..1b37fe25de2a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/DetachTrafficFilters_Update.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/detachTrafficFilter?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/ElasticVersions_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/ElasticVersions_List.json new file mode 100644 index 000000000000..e37835f399a6 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/ElasticVersions_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "region": "myregion", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "version1" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/ExternalUserInfo.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/ExternalUserInfo.json new file mode 100644 index 000000000000..3cab114f4033 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/ExternalUserInfo.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "UserName": "newuser", + "FullName": "fullname", + "Password": "Password", + "EmailId": "myemail@outlook.com", + "Roles": [ + "admin", + "other_role1" + ] + } + }, + "responses": { + "200": { + "body": { + "created": true + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/IPTrafficFilter_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/IPTrafficFilter_Create.json new file mode 100644 index 000000000000..ac58c4f3380c --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/IPTrafficFilter_Create.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd", + "ips": "192.168.131.0, 192.168.132.6/22" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/createAndAssociateIPFilter?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitor_Upgrade.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitor_Upgrade.json new file mode 100644 index 000000000000..ae0564ae3def --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitor_Upgrade.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "version": "7.15.1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/upgrade?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/MonitoredResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/MonitoredResources_List.json new file mode 100644 index 000000000000..7df161998148 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/MonitoredResources_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "sendingLogs": "True", + "reasonForLogsStatus": "CapturedByRules" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Create.json new file mode 100644 index 000000000000..312716ce8980 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Create.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + }, + "planDetails": { + "offerID": "00000", + "publisherID": "1234", + "termID": "free_Monthly", + "planID": "xxxyyy", + "planName": "myPlan" + }, + "saaSAzureSubscriptionStatus": "Subscribed", + "sourceCampaignName": "Elastic", + "sourceCampaignId": "0000" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Delete.json new file mode 100644 index 000000000000..e367af781176 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname?api-version=2022-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Get.json new file mode 100644 index 000000000000..b6aef6341fa0 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_List.json new file mode 100644 index 000000000000..f502c7e40573 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_ListByResourceGroup.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_ListByResourceGroup.json new file mode 100644 index 000000000000..091f71695eb9 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_ListByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Update.json new file mode 100644 index 000000000000..4ba77fd7c305 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Monitors_Update.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Operations_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..ac2924f10197 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Elastic/monitors/write", + "display": { + "provider": "Microsoft.Elastic", + "resource": "monitors", + "operation": "write", + "description": "Write monitors resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Organizations_GetApiKey.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Organizations_GetApiKey.json new file mode 100644 index 000000000000..deee38a5758f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Organizations_GetApiKey.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "requestBody": { + "emailId": "myemail@outlook.com" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "apiKey": "AbCdEfGhIjKlMnOpQrStUvWxYz" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json new file mode 100644 index 000000000000..541d31d56d8f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status" + }, + "elasticOrganizationId": "1234567890", + "elasticOrganizationName": "elasticOrganizationName" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/PrivateLinkTrafficFilters_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/PrivateLinkTrafficFilters_Create.json new file mode 100644 index 000000000000..c55dd36cff19 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/PrivateLinkTrafficFilters_Create.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd", + "privateEndpointName": "myPrivateEndpoint", + "privateEndpointGuid": "fdb54d3b-e85e-4d08-8958-0d2f7g523df9" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/createAndAssociatePLFilter?api-version=2022-07-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_CreateOrUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_CreateOrUpdate.json new file mode 100644 index 000000000000..e91c1a6de70e --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default", + "requestBody": { + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_Delete.json new file mode 100644 index 000000000000..be97e1cb8cac --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/tagRules/tagRuleName?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_Get.json new file mode 100644 index 000000000000..27d719de7d09 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_List.json new file mode 100644 index 000000000000..ff697c576627 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TagRules_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TrafficFilters_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TrafficFilters_Delete.json new file mode 100644 index 000000000000..317beba0bc4f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/TrafficFilters_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/UpgradableVersions_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/UpgradableVersions_Details.json new file mode 100644 index 000000000000..b521c66495ba --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/UpgradableVersions_Details.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "currentVersion": "7.15.0", + "upgradableVersions": [ + "7.15.1", + "7.16.0" + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/VMCollection_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/VMCollection_Update.json new file mode 100644 index 000000000000..0244ef377f80 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/VMCollection_Update.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM", + "operationName": "Add" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/VMHost_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/VMHost_List.json new file mode 100644 index 000000000000..f28a1cbe5ba9 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/VMHost_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/VMIngestion_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/VMIngestion_Details.json new file mode 100644 index 000000000000..56dd23df9d7a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-11-01-preview/examples/VMIngestion_Details.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "cloudId": "myid123", + "ingestionKey": "Vmingeationkey" + } + } + } +} diff --git a/specification/elastic/resource-manager/readme.md b/specification/elastic/resource-manager/readme.md index 94a8875881d9..d81ca937061a 100644 --- a/specification/elastic/resource-manager/readme.md +++ b/specification/elastic/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the elastic. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-10-01-preview +tag: package-2023-11-01-preview ``` ### Tag: package-2021-09-01-preview @@ -147,6 +147,15 @@ input-file: - Microsoft.Elastic/preview/2023-10-01-preview/elastic.json ``` +### Tag: package-2023-11-01-preview + +These settings apply only when `--tag=package-2023-11-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-11-01-preview' +input-file: + - Microsoft.Elastic/preview/2023-11-01-preview/elastic.json +``` + --- # Code Generation diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index c44046e5aa9d..5459d39db65e 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -14,7 +14,7 @@ This enables customers to download one EventGrid data plane library instead of h ### Guidelines for defining a new event -> **_NOTE:_** New events must not be delivered to Event Grid production endpoints until the events have been reviewed with the Azure SDK Architecture board and the PR is merged into main. Once the PR is merged to main, the events are considered GA regardless of whether docs list them as being in preview. This is because customers cannot control which version of events they consume - it is entirely up to the service publishing the events. Any breaking changes to events would need to be implemented as a new event type. Full details can be found in the [Azure Breaking Changes Policy](http://aka.ms/AzBreakingChangesPolicy/), Section 4. +> **_NOTE:_** New events must not be delivered to Event Grid production endpoints until the events have been reviewed with the Azure SDK Architecture board and the PR is merged into main. The architecture board meeting will be scheduled by a member of the Azure SDK team - you do not need to use the scheduling tool. Once the PR is merged to main, the events are considered GA regardless of whether docs list them as being in preview. This is because customers cannot control which version of events they consume - it is entirely up to the service publishing the events. Any breaking changes to events would need to be implemented as a new event type. Full details can be found in the [Azure Breaking Changes Policy](http://aka.ms/AzBreakingChangesPolicy/), Section 4. In order to automate the mapping of event definition with event type, please follow the guidelines below when adding new events to your swagger: - The name of a new event definition should have `EventData` suffix. For e.g. `AcsChatMessageReceivedEventData`. diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json new file mode 100644 index 000000000000..cdcb4aa56cce --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json @@ -0,0 +1,980 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Cloud HSM Resource Provider", + "description": "The Azure management API provides a RESTful set of web services that interact with Azure Cloud HSM RP.", + "version": "2023-12-10-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}": { + "put": { + "tags": [ + "" + ], + "operationId": "CloudHsmClusters_CreateOrUpdate", + "description": "Create or Update a Cloud HSM Cluster in the specified subscription.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/cloudHsmClusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CloudHsmCluster" + }, + "description": "Parameters to create Cloud HSM Cluster" + } + ], + "responses": { + "200": { + "description": "Created or Update Cloud HSM Cluster", + "schema": { + "$ref": "#/definitions/CloudHsmCluster" + } + }, + "201": { + "description": "Created or Update Cloud HSM Cluster", + "schema": { + "$ref": "#/definitions/CloudHsmCluster" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-examples": { + "CloudHsmCluster_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmCluster_CreateOrUpdate_MaximumSet_Gen.json" + } + } + }, + "patch": { + "tags": [ + "" + ], + "operationId": "CloudHsmClusters_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Update a Cloud HSM Cluster in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/cloudHsmClusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/CloudHsmClusterPatchParameters" + }, + "description": "Parameters to create Cloud HSM Cluster" + } + ], + "responses": { + "200": { + "description": "Patched Cloud HSM Cluster", + "schema": { + "$ref": "#/definitions/CloudHsmCluster" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-examples": { + "CloudHsmCluster_Update_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmCluster_Update_MaximumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "" + ], + "operationId": "CloudHsmClusters_Get", + "description": "Gets the specified Cloud HSM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/cloudHsmClusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved Cloud HSM Cluster", + "schema": { + "$ref": "#/definitions/CloudHsmCluster" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-examples": { + "CloudHsmCluster_Get_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmCluster_Get_MaximumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "" + ], + "operationId": "CloudHsmClusters_Delete", + "description": "Deletes the specified Cloud HSM Cluster", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/cloudHsmClusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK Response." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-examples": { + "CloudHsmCluster_Delete_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmCluster_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters": { + "get": { + "tags": [ + "" + ], + "operationId": "CloudHsmClusters_ListByResourceGroup", + "description": "The List operation gets information about the Cloud HSM Clusters associated with the subscription and within the specified resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "in": "query", + "name": "$skiptoken", + "type": "string", + "required": false, + "description": "The page-continuation token to use with a paged version of this API" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all Cloud HSM Clusters in the specified resource group.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CloudHsmCluster_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmCluster_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters": { + "get": { + "tags": [ + "" + ], + "operationId": "CloudHsmClusters_ListBySubscription", + "description": "The List operation gets information about the Cloud HSM Clusters associated with the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "query", + "name": "$skiptoken", + "type": "string", + "required": false, + "description": "The page-continuation token to use with a paged version of this API" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Get information about all Cloud HSM Clusters in the specified subscription.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CloudHsmCluster_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmCluster_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateLinkResources": { + "get": { + "tags": [ + "" + ], + "operationId": "CloudHsmClusterPrivateLinkResources_ListByCloudHsmCluster", + "description": "Gets the private link resources supported for the Cloud Hsm Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/cloudHsmClusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-examples": { + "CloudHsmClusterPrivateLinkResources_ListByResource_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmClusterPrivateLinkResource_ListByCloudHsmCluster_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateEndpointConnections/{peConnectionName}": { + "put": { + "tags": [ + "" + ], + "operationId": "CloudHsmClusterPrivateEndpointConnections_Create", + "description": "Creates or updates the private endpoint connection for the Cloud Hsm Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/cloudHsmClusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/peConnectionName" + }, + { + "in": "body", + "name": "properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters of the PrivateEndpointConnection" + } + ], + "responses": { + "200": { + "description": "OK -- Create or Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-examples": { + "CloudHsmClusterPrivateEndpointConnection_Create_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmClusterPrivateEndpointConnection_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "" + ], + "operationId": "CloudHsmClusterPrivateEndpointConnections_Delete", + "description": "Deletes the private endpoint connection for the Cloud Hsm Cluster.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/cloudHsmClusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/peConnectionName" + } + ], + "responses": { + "200": { + "description": "The private endpoint connection was successfully deleted." + }, + "202": { + "description": "The private endpoint connection is being deleted.", + "headers": { + "Location": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "The private endpoint connection does not exist." + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-examples": { + "CloudHsmClusterPrivateEndpointConnection_Delete_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmClusterPrivateEndpointConnection_Delete_MaximumSet_Gen.json" + } + } + }, + "get": { + "tags": [ + "" + ], + "operationId": "CloudHsmClusterPrivateEndpointConnections_Get", + "description": "Gets the private endpoint connection for the Cloud Hsm Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/cloudHsmClusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/peConnectionName" + } + ], + "responses": { + "200": { + "description": "Private endpoint connection successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-examples": { + "CloudHsmClusterPrivateEndpointConnection_Get_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmClusterPrivateEndpointConnection_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/{cloudHsmClusterName}/privateEndpointConnections": { + "get": { + "tags": [ + "" + ], + "operationId": "PrivateEndpointConnections_ListByCloudHsmCluster", + "description": "The List operation gets information about the private endpoint connections associated with the Cloud HSM Cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/cloudHsmClusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all CloudHsmCluster private endpoint connections associated with the Cloud HSM Cluster.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "The error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudHsmClusterError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CloudHsmClusterPrivateEndpointConnection_ListByResource_MaximumSet_Gen": { + "$ref": "./examples/CloudHsmClusterPrivateEndpointConnection_ListByCloudHsmCluster_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "CloudHsmProperties": { + "type": "object", + "description": "The Cloud HSM Properties", + "properties": { + "fqdn": { + "type": "string", + "description": "FQDN of the Cloud HSM" + }, + "state": { + "type": "string", + "description": "The Cloud HSM State" + }, + "stateMessage": { + "type": "string", + "description": "The Cloud HSM State message" + } + } + }, + "CloudHsmCluster": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CloudHsmClusterProperties", + "description": "Properties of the Cloud HSM Cluster" + } + }, + "allOf": [ + { + "$ref": "#/definitions/CloudHsmClusterResource" + } + ], + "description": "Resource information with extended details.", + "type": "object" + }, + "CloudHsmClusterResource": { + "properties": { + "sku": { + "$ref": "#/definitions/CloudHsmClusterSku", + "description": "SKU details" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Cloud HSM Cluster Resource", + "type": "object", + "x-ms-azure-resource": true + }, + "CloudHsmClusterProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "The Cloud HSM Cluster's provisioningState", + "enum": [ + "Provisioning", + "Succeeded", + "Failed", + "Deleting", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "autoGeneratedDomainNameLabelScope": { + "type": "string", + "description": "The Cloud HSM Cluster's auto-generated Domain Name Label Scope" + }, + "securityDomain": { + "$ref": "#/definitions/CloudHsmClusterSecurityDomainProperties" + }, + "hsms": { + "type": "array", + "description": "An array of Cloud HSM Cluster's HSMs", + "x-ms-identifiers": [ + "fqdn" + ], + "items": { + "$ref": "#/definitions/CloudHsmProperties" + } + }, + "publicNetworkAccess": { + "type": "string", + "description": "The Cloud HSM Cluster public network access" + }, + "privateEndpointConnections": { + "type": "array", + "description": "List of private endpoint connection resources", + "x-ms-identifiers": [ + "name" + ], + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "statusMessage": { + "type": "string", + "description": "Cloud HSM Cluster status message", + "readOnly": true + }, + "restoreProperties": { + "$ref": "#/definitions/RestoreProperties" + }, + "backupProperties": { + "$ref": "#/definitions/BackupProperties" + } + }, + "description": "Properties of a Cloud HSM Cluster.", + "type": "object" + }, + "CloudHsmClusterPatchParameters": { + "properties": { + "tags": { + "type": "object", + "description": "The Cloud HSM Cluster's tags", + "additionalProperties": { + "type": "string", + "description": "The Cloud HSM Cluster's tag's additional properties" + } + }, + "sku": { + "$ref": "#/definitions/CloudHsmClusterSku", + "description": "SKU details" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "Properties of the Cloud HSM Cluster", + "properties": { + "backupProperties": { + "$ref": "#/definitions/BackupProperties" + } + } + } + }, + "description": "Patchable properties of the Cloud HSM Cluster", + "type": "object" + }, + "CloudHsmClusterSecurityDomainProperties": { + "type": "object", + "description": "Security domain properties information for Cloud HSM cluster", + "properties": { + "fipsState": { + "format": "int32", + "type": "integer", + "description": "FIPS state information for security domain" + }, + "activationStatus": { + "type": "string", + "description": "status of security domain activation" + } + } + }, + "CloudHsmClusterSku": { + "type": "object", + "description": "Cloud Hsm Cluster SKU information", + "required": [ + "name", + "family" + ], + "properties": { + "family": { + "type": "string", + "description": "Sku family of the Cloud HSM Cluster", + "enum": [ + "B" + ], + "x-ms-client-default": "B", + "x-ms-enum": { + "name": "CloudHsmClusterSkuFamily", + "modelAsString": true + } + }, + "name": { + "type": "string", + "description": "Sku name of the Cloud HSM Cluster", + "enum": [ + "Standard_B1", + "Standard B10" + ], + "x-ms-enum": { + "name": "CloudHsmClusterSkuName", + "modelAsString": false + } + }, + "capacity": { + "format": "int32", + "type": "integer", + "description": "Sku capacity" + } + } + }, + "BackupProperties": { + "type": "object", + "description": "Cloud Hsm Cluster backup information", + "properties": { + "azureStorageResourceUri": { + "type": "string", + "description": "Azure storage Resource Uri" + }, + "lastBackupDateTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Last Date Time that Customer Enabled Backup was taken" + }, + "lastBackupStatus": { + "type": "string", + "readOnly": true, + "description": "Status of last backup" + } + } + }, + "RestoreProperties": { + "type": "object", + "description": "Cloud Hsm Cluster restore information", + "properties": { + "foldername": { + "type": "string", + "description": "Directory name in Azure Storage Blob where the backup is stored" + }, + "azureStorageResourceUri": { + "type": "string", + "description": "Azure Blob storage container Uri" + } + } + }, + "CloudHsmClusterError": { + "properties": { + "error": { + "$ref": "#/definitions/CHsmError" + } + }, + "description": "The Cloud HSM Cluster error details", + "type": "object" + }, + "CHsmError": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The error message." + } + }, + "type": "object", + "description": "Error details" + }, + "CloudHsmClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudHsmCluster" + }, + "description": "The list of Cloud HSM Clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of Cloud HSM Clusters." + } + }, + "description": "List of Cloud HSM Clusters", + "type": "object" + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + }, + "etag": { + "type": "string", + "description": "Modified whenever there is a change in the state of private endpoint connection." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "The private endpoint connection resource.", + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateEndpoint", + "description": "The private endpoint resource." + }, + "privateLinkServiceConnectionState": { + "$ref": "../../../../../common-types/resource-management/v4/privatelinks.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + }, + "groupIds": { + "description": "The group ids for the private endpoint resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the private endpoint connection." + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed", + "Updating", + "InternalError", + "Canceled" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of private endpoint connections." + } + }, + "description": "List of private endpoint connections associated with the specified resource." + } + }, + "parameters": { + "cloudHsmClusterName": { + "name": "cloudHsmClusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 24 characters in length.", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "peConnectionName": { + "name": "peConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the private endpoint connection associated with the Cloud HSM Cluster.", + "pattern": "^[a-zA-Z0-9-]{3,24}$", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_Create_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..646dafdae6a5 --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_Create_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgcloudhsm", + "cloudHsmClusterName": "chsm1", + "api-version": "2023-12-10-preview", + "peConnectionName": "sample-pec", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "My name is Joe and I'm approving this." + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters/privateEndpointConnections", + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "User2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.Network/privateEndpoints/sample-pec" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "My name is Joe and I'm approving this.", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_Delete_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..81bf363e9edb --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgcloudhsm", + "cloudHsmClusterName": "chsm1", + "api-version": "2023-12-10-preview", + "peConnectionName": "sample-pec" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1/privateEndpointConnections/sample-pec?operationid=25334578" + } + }, + "204": {} + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_Get_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..bad05d1d590d --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgcloudhsm", + "cloudHsmClusterName": "chsm1", + "api-version": "2023-12-10-preview", + "peConnectionName": "sample-pec" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1/privateEndpointConnections/sample-pec", + "name": "sample-pec", + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters/privateEndpointConnections", + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "User2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pec" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_ListByCloudHsmCluster_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_ListByCloudHsmCluster_MaximumSet_Gen.json new file mode 100644 index 000000000000..dac4dda54541 --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateEndpointConnection_ListByCloudHsmCluster_MaximumSet_Gen.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgcloudhsm", + "cloudHsmClusterName": "chsm1", + "api-version": "2023-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1/privateEndpointConnections/sample-pec1", + "name": "chsm1", + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters/privateEndpointConnections", + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "User2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.Network/privateEndpoints/sample-pec1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm2/privateEndpointConnections/sample-pec2", + "name": "chsm2", + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters/privateEndpointConnections", + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-01-01T12:00:00.0000000Z", + "lastModifiedBy": "User2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-01T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.Network/privateEndpoints/sample-pec2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "This was automatically approved by user1234@contoso.com", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateLinkResource_ListByCloudHsmCluster_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateLinkResource_ListByCloudHsmCluster_MaximumSet_Gen.json new file mode 100644 index 000000000000..f16ba148ab90 --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmClusterPrivateLinkResource_ListByCloudHsmCluster_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgcloudhsm", + "cloudHsmClusterName": "chsm1", + "api-version": "2023-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1/privateLinkResources/sample-pls", + "name": "sample-pls", + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters/privateLinkResources", + "properties": { + "groupId": "cloudHsm", + "requiredMembers": [ + "hsm1", + "hsm2", + "hsm3" + ], + "requiredZoneNames": [ + "privatelink.cloudhsm.azure-int.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_CreateOrUpdate_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..f5db634778bc --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgcloudhsm", + "cloudHsmClusterName": "chsm1", + "api-version": "2023-12-10-preview", + "body": { + "location": "eastus2", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + }, + "properties": { + "securityDomain": { + "fipsState": 2 + }, + "publicNetworkAccess": "Disabled", + "backupProperties": { + "azureStorageResourceUri": "testStorageResourceUri" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "chsm1", + "location": "eastus2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + }, + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters", + "systemData": { + "createdBy": "CHsmUser1", + "createdByType": "User", + "createdAt": "2022-09-12T12:00:00.0000000Z", + "lastModifiedBy": "CHsmUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-12T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "securityDomain": { + "fipsState": 2, + "activationStatus": "null" + }, + "hsms": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": null, + "backupProperties": { + "azureStorageResourceUri": "testStorageResourceUri", + "lastBackupDateTime": "2023-11-09T12:00:00.0000000Z", + "lastBackupStatus": "Status Of last backup" + }, + "statusMessage": "This is a status message" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + }, + "201": { + "body": { + "name": "chsm1", + "location": "eastus2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + }, + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters", + "systemData": { + "createdBy": "CHsmUser1", + "createdByType": "User", + "createdAt": "2022-09-12T12:00:00.0000000Z", + "lastModifiedBy": "CHsmUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-12T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "securityDomain": { + "fipsState": 2, + "activationStatus": "null" + }, + "hsms": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": null, + "backupProperties": { + "azureStorageResourceUri": "testStorageResourceUri", + "lastBackupDateTime": "2023-11-09T12:00:00.0000000Z", + "lastBackupStatus": "Status Of last backup" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_Delete_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..c5c5603ef1ac --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_Delete_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgcloudhsm", + "cloudHsmClusterName": "chsm1", + "api-version": "2023-12-10-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1?api-version=2022-03-31&operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9" + } + }, + "204": {} + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_Get_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..edc403dba30a --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_Get_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgcloudhsm", + "cloudHsmClusterName": "chsm1", + "api-version": "2023-12-10-preview" + }, + "responses": { + "200": { + "body": { + "name": "chsm1", + "location": "eastus2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + }, + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters", + "systemData": { + "createdBy": "CHsmUser1", + "createdByType": "User", + "createdAt": "2022-09-12T12:00:00.0000000Z", + "lastModifiedBy": "CHsmUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-12T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "securityDomain": { + "fipsState": 2, + "activationStatus": "null" + }, + "hsms": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": null, + "backupProperties": { + "azureStorageResourceUri": "testStorageResourceUri", + "lastBackupDateTime": "2023-11-09T12:00:00.0000000Z", + "lastBackupStatus": "Status Of last backup" + }, + "statusMessage": "This is a status message" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_ListByResourceGroup_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..b4fa2933c522 --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgcloudhsm", + "api-version": "2023-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "chsm1", + "location": "eastus2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + }, + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters", + "systemData": { + "createdBy": "CHsmUser1", + "createdByType": "User", + "createdAt": "2022-09-12T12:00:00.0000000Z", + "lastModifiedBy": "CHsmUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-12T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "securityDomain": { + "fipsState": 2, + "activationStatus": "null" + }, + "hsms": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": null, + "backupProperties": { + "azureStorageResourceUri": "testStorageResourceUri", + "lastBackupDateTime": "2023-11-09T12:00:00.0000000Z", + "lastBackupStatus": "Status Of last backup" + }, + "statusMessage": "This is a status message" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + }, + { + "name": "chsm2", + "location": "eastus2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm2", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + }, + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters", + "systemData": { + "createdBy": "CHsmUser1", + "createdByType": "User", + "createdAt": "2022-09-12T12:00:00.0000000Z", + "lastModifiedBy": "CHsmUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-12T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "securityDomain": { + "fipsState": 2, + "activationStatus": "null" + }, + "hsms": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": null, + "backupProperties": { + "azureStorageResourceUri": "testStorageResourceUri", + "lastBackupDateTime": "2023-11-09T12:00:00.0000000Z", + "lastBackupStatus": "Status Of last backup" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-2": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters?api-version=2022-03-31&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_ListBySubscription_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..0576e3efd6eb --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-12-10-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "chsm1", + "location": "eastus2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + }, + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters", + "systemData": { + "createdBy": "CHsmUser1", + "createdByType": "User", + "createdAt": "2022-09-12T12:00:00.0000000Z", + "lastModifiedBy": "CHsmUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-12T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "securityDomain": { + "fipsState": 2, + "activationStatus": "null" + }, + "hsms": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": null, + "backupProperties": { + "azureStorageResourceUri": "testStorageResourceUri", + "lastBackupDateTime": "2023-11-09T12:00:00.0000000Z", + "lastBackupStatus": "Status Of last backup" + }, + "statusMessage": "This is a status message" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": { + "principalId": null, + "clientId": null + } + } + } + }, + { + "name": "chsm2", + "location": "eastus2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm2", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood" + }, + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters", + "systemData": { + "createdBy": "CHsmUser1", + "createdByType": "User", + "createdAt": "2022-09-12T12:00:00.0000000Z", + "lastModifiedBy": "CHsmUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-12T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "securityDomain": { + "fipsState": 2, + "activationStatus": "null" + }, + "hsms": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": null, + "backupProperties": { + "azureStorageResourceUri": "testStorageResourceUri", + "lastBackupDateTime": "2023-11-09T12:00:00.0000000Z", + "lastBackupStatus": "Status Of last backup" + }, + "statusMessage": "This is a status message" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-2": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" + } + } + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_Update_MaximumSet_Gen.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..92f59deedeed --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/examples/CloudHsmCluster_Update_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgcloudhsm", + "cloudHsmClusterName": "chsm1", + "api-version": "2023-12-10-preview", + "body": { + "tags": { + "Dept": "hsm", + "Environment": "dogfood", + "Slice": "A" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": {} + } + }, + "properties": { + "backupProperties": { + "azureStorageResourceUri": "testStorageResourceUri" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "chsm1", + "location": "eastus2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1", + "sku": { + "family": "B", + "name": "Standard_B1" + }, + "tags": { + "Dept": "hsm", + "Environment": "dogfood", + "Slice": "A" + }, + "type": "Microsoft.HardwareSecurityModules/cloudHsmClusters", + "systemData": { + "createdBy": "CHsmUser1", + "createdByType": "User", + "createdAt": "2022-09-12T12:00:00.0000000Z", + "lastModifiedBy": "CHsmUser2", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-12T12:00:00.0000000Z" + }, + "properties": { + "provisioningState": "Succeeded", + "autoGeneratedDomainNameLabelScope": "TenantReuse", + "securityDomain": { + "fipsState": 2, + "activationStatus": "null" + }, + "hsms": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": null, + "backupProperties": { + "azureStorageResourceUri": "testStorageResourceUri", + "lastBackupDateTime": "2023-11-09T12:00:00.0000000Z", + "lastBackupStatus": "Status Of last backup" + }, + "statusMessage": "This is a status message" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-1": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm/providers/Microsoft.HardwareSecurityModules/cloudHsmClusters/chsm1?api-version=2022-07-01&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9" + } + } + } +} diff --git a/specification/hardwaresecuritymodules/resource-manager/readme.go.md b/specification/hardwaresecuritymodules/resource-manager/readme.go.md index 69802444eacb..2ff7cb732e18 100644 --- a/specification/hardwaresecuritymodules/resource-manager/readme.go.md +++ b/specification/hardwaresecuritymodules/resource-manager/readme.go.md @@ -15,12 +15,15 @@ module-name: sdk/resourcemanager/hardwaresecuritymodules/armhardwaresecuritymodu module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true +modelerfour: + lenient-model-deduplication: true ``` ### Go multi-api ```yaml $(go) && $(multiapi) batch: + - tag: package-2023-12-preview - tag: package-2022-08-preview - tag: package-2021-11 - tag: package-2018-10 @@ -50,4 +53,14 @@ These settings apply only when `--tag=package-2022-08-preview --go` is specified Please also specify `--go-sdk-folder=`. ```yaml $(tag)=='package-2022-08-preview' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2022-08-31-preview/$(namespace) \ No newline at end of file +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2022-08-31-preview/$(namespace) +``` + +### Tag: package-2023-12 and go + +These settings apply only when `--tag=package-2023-12-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag)=='package-2023-12-preview' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/package-2023-12-preview/$(namespace) +``` diff --git a/specification/hardwaresecuritymodules/resource-manager/readme.md b/specification/hardwaresecuritymodules/resource-manager/readme.md index 95abf20b05c4..4d8b4417f60a 100644 --- a/specification/hardwaresecuritymodules/resource-manager/readme.md +++ b/specification/hardwaresecuritymodules/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for hardware security module RP. - - --- + ## Getting Started + To build the SDK for hardware security modules, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,23 +15,22 @@ To build the SDK for hardware security modules, simply [Install AutoRest](https: To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the Hardware Security Modules API. ``` yaml title: Azure HSM Resource Provider description: The Azure management API provides a RESTful set of web services that interact with Azure HSM RP. openapi-type: arm -tag: package-2022-08-preview +tag: package-2023-12-preview ``` - ### Tag: package-2018-10 These settings apply only when `--tag=package-2018-10` is specified on the command line. @@ -60,8 +59,17 @@ input-file: - Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json ``` -# Code Generation +### Tag: package-2023-12-preview + +These settings apply only when `--tag=package-2023-12-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-12-preview' +input-file: + - Microsoft.HardwareSecurityModules/preview/2023-12-10-preview/cloudhsm.json + - Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json +``` +# Code Generation ## Swagger to SDK @@ -77,4 +85,3 @@ swagger-to-sdk: - repo: azure-powershell - repo: azure-sdk-for-java ``` - diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateAutoscaleCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateAutoscaleCluster.json index ef5b63e96ac4..daa33d9609b1 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateAutoscaleCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateAutoscaleCluster.json @@ -8,19 +8,24 @@ "HDInsightCluster": { "location": "West US 2", "properties": { - "clusterType": "kafka", + "clusterType": "Trino", "computeProfile": { "nodes": [ { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 } ] }, "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", "identityProfile": { "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", @@ -32,7 +37,7 @@ "testuser2" ] }, - "kafkaProfile": {}, + "trinoProfile": {}, "sshProfile": { "count": 2 }, @@ -101,24 +106,33 @@ "type": "Microsoft.HDInsight/clusterPools/clusters", "properties": { "provisioningState": "Succeeded", - "clusterType": "kafka", + "clusterType": "Trino", "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", "computeProfile": { "nodes": [ { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 } ] }, "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", "components": [ { - "name": "Hive", - "version": "2.4.1" + "name": "Trino", + "version": "410" + }, + { + "name": "Hive metastore", + "version": "3.1.2" } ], "identityProfile": { @@ -145,7 +159,7 @@ } ] }, - "kafkaProfile": {}, + "trinoProfile": {}, "sshProfile": { "count": 2, "podPrefix": "sshnode" @@ -223,19 +237,24 @@ "type": "Microsoft.HDInsight/clusterPools/clusters", "properties": { "provisioningState": "Accepted", - "clusterType": "kafka", + "clusterType": "Trino", "computeProfile": { "nodes": [ { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 } ] }, "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", "identityProfile": { "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", @@ -260,7 +279,7 @@ } ] }, - "kafkaProfile": {}, + "trinoProfile": {}, "sshProfile": { "count": 2, "podPrefix": "sshnode" diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetCluster.json index d3df7c8b1424..9eaad022d260 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetCluster.json @@ -14,24 +14,33 @@ "type": "Microsoft.HDInsight/clusterPools/clusters", "properties": { "provisioningState": "Succeeded", - "clusterType": "kafka", + "clusterType": "Trino", "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", "computeProfile": { "nodes": [ { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 } ] }, "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", "components": [ { - "name": "Hive", - "version": "2.4.1" + "name": "Trino", + "version": "410" + }, + { + "name": "Hive metastore", + "version": "3.1.2" } ], "identityProfile": { @@ -58,7 +67,7 @@ } ] }, - "kafkaProfile": {}, + "trinoProfile": {}, "sshProfile": { "count": 2, "podPrefix": "sshnode" diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClustersByClusterPoolName.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClustersByClusterPoolName.json index d44a41d76507..903f8f90bdec 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClustersByClusterPoolName.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClustersByClusterPoolName.json @@ -15,24 +15,33 @@ "type": "Microsoft.HDInsight/clusterPools/clusters", "properties": { "provisioningState": "Succeeded", - "clusterType": "kafka", + "clusterType": "Trino", "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", "computeProfile": { "nodes": [ { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 } ] }, "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", "components": [ { - "name": "Hive", - "version": "2.4.1" + "name": "Trino", + "version": "410" + }, + { + "name": "Hive metastore", + "version": "3.1.2" } ], "identityProfile": { @@ -59,7 +68,7 @@ } ] }, - "kafkaProfile": {}, + "trinoProfile": {}, "sshProfile": { "count": 2, "podPrefix": "sshnode" diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/PatchCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/PatchCluster.json index a6758a9d0626..f43f807874e3 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/PatchCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/PatchCluster.json @@ -124,20 +124,25 @@ "type": "Microsoft.HDInsight/clusterPools/clusters", "properties": { "provisioningState": "Succeeded", - "clusterType": "kafka", + "clusterType": "Trino", "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", "computeProfile": { "nodes": [ { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 } ] }, "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", "identityProfile": { "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", @@ -256,7 +261,7 @@ } ] }, - "kafkaProfile": {}, + "trinoProfile": {}, "sshProfile": { "count": 2, "podPrefix": "sshnode" @@ -288,20 +293,25 @@ "type": "Microsoft.HDInsight/clusterPools/clusters", "properties": { "provisioningState": "Succeeded", - "clusterType": "kafka", + "clusterType": "Trino", "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", "computeProfile": { "nodes": [ { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 3 } ] }, "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", "identityProfile": { "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", @@ -420,7 +430,7 @@ } ] }, - "kafkaProfile": {}, + "trinoProfile": {}, "sshProfile": { "count": 2, "podPrefix": "sshnode" diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ResizeCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ResizeCluster.json index 57f4a5eb1f75..acdc0d83e062 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ResizeCluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ResizeCluster.json @@ -20,20 +20,25 @@ "type": "Microsoft.HDInsight/clusterPools/clusters", "properties": { "provisioningState": "Succeeded", - "clusterType": "kafka", + "clusterType": "Trino", "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", "computeProfile": { "nodes": [ { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 3 + "type": "Head", + "vmSize": "Standard_E8as_v5", + "count": 2 + }, + { + "type": "Worker", + "vmSize": "Standard_E8as_v5", + "count": 5 } ] }, "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", + "clusterVersion": "1.0.6", + "ossVersion": "0.410.0", "identityProfile": { "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", @@ -58,7 +63,7 @@ } ] }, - "kafkaProfile": {}, + "trinoProfile": {}, "sshProfile": { "count": 2, "podPrefix": "sshnode" diff --git a/specification/hybridaks/resource-manager/Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json b/specification/hybridaks/resource-manager/Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json index d3cc2fe45b1b..7a1c6b85d7cf 100644 --- a/specification/hybridaks/resource-manager/Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json +++ b/specification/hybridaks/resource-manager/Microsoft.HybridContainerService/preview/2023-11-15-preview/provisionedClusterInstances.json @@ -1775,7 +1775,7 @@ "type": "array", "description": "List of supported Kubernetes versions", "items": { - "$ref": "#/definitions/KubernetesVersionProfileProperties" + "$ref": "#/definitions/KubernetesVersionProperties" }, "x-ms-identifiers": [] } @@ -1783,7 +1783,7 @@ } } }, - "KubernetesVersionProfileProperties": { + "KubernetesVersionProperties": { "type": "object", "description": "Kubernetes version profile for given major.minor release", "properties": { @@ -1866,19 +1866,7 @@ } }, "osSku": { - "type": "string", - "description": "The particular KubernetesVersion's Image's OS SKU (CBLMariner, Windows, Windows2022)", - "readOnly": true, - "enum": [ - "CBLMariner", - "Windows2019", - "Windows2022" - ], - "default": "CBLMariner", - "x-ms-enum": { - "modelAsString": true, - "name": "osSku" - } + "$ref": "#/definitions/OSSKU" }, "ready": { "type": "boolean", @@ -1948,7 +1936,7 @@ "type": "array", "description": "Array of HybridAKS Support VM Skus", "items": { - "$ref": "#/definitions/VmSkuProfileProperties" + "$ref": "#/definitions/VmSkuProperties" }, "x-ms-identifiers": [] } @@ -1956,7 +1944,7 @@ } } }, - "VmSkuProfileProperties": { + "VmSkuProperties": { "type": "object", "description": "The profile for supported VM skus", "readOnly": true, diff --git a/specification/iotoperationsdataprocessor/readme.java.md b/specification/iotoperationsdataprocessor/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/iotoperationsdataprocessor/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/iotoperationsmq/resource-manager/readme.java.md b/specification/iotoperationsmq/resource-manager/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/iotoperationsmq/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/iotoperationsorchestrator/resource-manager/readme.java.md b/specification/iotoperationsorchestrator/resource-manager/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/iotoperationsorchestrator/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/liftrastronomer/resource-manager/readme.java.md b/specification/liftrastronomer/resource-manager/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/liftrastronomer/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/examples/Monitors_Delete.json b/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/examples/Monitors_Delete.json index 714a9adac970..dac59052f0c3 100644 --- a/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/examples/Monitors_Delete.json +++ b/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/examples/Monitors_Delete.json @@ -7,7 +7,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Logz/monitors/test?api-version=2020-10-01-preview" + } + }, "204": {} } } diff --git a/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/examples/SubAccount_Delete.json b/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/examples/SubAccount_Delete.json index 705fcb4328eb..7add79437a9c 100644 --- a/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/examples/SubAccount_Delete.json +++ b/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/examples/SubAccount_Delete.json @@ -8,7 +8,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Logz/monitors/test?api-version=2020-10-01-preview" + } + }, "204": {} } } diff --git a/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/logz.json b/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/logz.json index 2123c23aa81b..9416e695675d 100644 --- a/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/logz.json +++ b/specification/logz/resource-manager/Microsoft.Logz/preview/2020-10-01-preview/logz.json @@ -19,7 +19,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", + "description": "Microsoft Entra ID OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } diff --git a/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/MetricsSource_Delete.json b/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/MetricsSource_Delete.json index e1d37d82583c..7d6eb2ebba3b 100644 --- a/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/MetricsSource_Delete.json +++ b/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/MetricsSource_Delete.json @@ -8,7 +8,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Logz/monitors/test?api-version=2022-01-01-preview" + } + }, "204": {} } } diff --git a/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/Monitors_Delete.json b/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/Monitors_Delete.json index 656e98f098ba..8cc8ce3aa67d 100644 --- a/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/Monitors_Delete.json +++ b/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/Monitors_Delete.json @@ -7,7 +7,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Logz/monitors/test?api-version=2022-01-01-preview" + } + }, "204": {} } } diff --git a/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/SubAccount_Delete.json b/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/SubAccount_Delete.json index c575d87cd143..706b7c10b112 100644 --- a/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/SubAccount_Delete.json +++ b/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/examples/SubAccount_Delete.json @@ -8,7 +8,11 @@ }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Logz/monitors/test?api-version=2022-01-01-preview" + } + }, "204": {} } } diff --git a/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/logz.json b/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/logz.json index 27e06bfbc93d..f0f2c3a20c34 100644 --- a/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/logz.json +++ b/specification/logz/resource-manager/Microsoft.Logz/preview/2022-01-01-preview/logz.json @@ -19,7 +19,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", + "description": "Microsoft Entra ID OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } diff --git a/specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/logz.json b/specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/logz.json index dc5bf5834839..3b6b7109ac4d 100644 --- a/specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/logz.json +++ b/specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/logz.json @@ -19,7 +19,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", + "description": "Microsoft Entra ID OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } diff --git a/specification/maps/data-plane/Route/preview/2023-10-01-preview/examples/PostRouteDirections.json b/specification/maps/data-plane/Route/preview/2023-10-01-preview/examples/PostRouteDirections.json index 82c3da963f10..e2afb73d26f4 100644 --- a/specification/maps/data-plane/Route/preview/2023-10-01-preview/examples/PostRouteDirections.json +++ b/specification/maps/data-plane/Route/preview/2023-10-01-preview/examples/PostRouteDirections.json @@ -47,7 +47,7 @@ } } ], - "optimizeRoute": "fastestWithoutTraffic", + "optimizeRoute": "fastestWithTraffic", "routeOutputOptions": [ "routePath" ], diff --git a/specification/maps/data-plane/Route/preview/2023-10-01-preview/examples/PostRouteDirectionsBatch.json b/specification/maps/data-plane/Route/preview/2023-10-01-preview/examples/PostRouteDirectionsBatch.json index 87fe91d60e8d..00bd2ed8aeaa 100644 --- a/specification/maps/data-plane/Route/preview/2023-10-01-preview/examples/PostRouteDirectionsBatch.json +++ b/specification/maps/data-plane/Route/preview/2023-10-01-preview/examples/PostRouteDirectionsBatch.json @@ -35,7 +35,7 @@ } } ], - "optimizeRoute": "fastestWithoutTraffic", + "optimizeRoute": "fastestWithTraffic", "routeOutputOptions": [ "routeSummary" ], @@ -74,7 +74,7 @@ } } ], - "optimizeRoute": "fastestWithoutTraffic", + "optimizeRoute": "fastestWithTraffic", "routeOutputOptions": [ "routeSummary" ], diff --git a/specification/maps/data-plane/Route/preview/2023-10-01-preview/route.json b/specification/maps/data-plane/Route/preview/2023-10-01-preview/route.json index 52ef269a5834..2d89580240b2 100644 --- a/specification/maps/data-plane/Route/preview/2023-10-01-preview/route.json +++ b/specification/maps/data-plane/Route/preview/2023-10-01-preview/route.json @@ -468,7 +468,7 @@ "readOnly": true }, "durationTrafficInSeconds": { - "description": "The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. This value is always provided for the complete route and does not depend on the availability of traffic information.", + "description": "The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. This value is provided if optimizeRoute includes traffic considerations.", "format": "int64", "type": "integer", "readOnly": true @@ -772,7 +772,7 @@ "readOnly": true }, "durationTrafficInSeconds": { - "description": "The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. This value is always provided for the complete route and does not depend on the availability of traffic information.", + "description": "The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. This value is provided if optimizeRoute includes traffic considerations.", "format": "int64", "type": "integer", "readOnly": true @@ -894,7 +894,7 @@ "readOnly": true }, "durationTrafficInSeconds": { - "description": "The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. This value is always provided for the complete route and does not depend on the availability of traffic information.", + "description": "The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. This value is provided if optimizeRoute includes traffic considerations.", "format": "int64", "type": "integer", "readOnly": true @@ -926,7 +926,7 @@ "readOnly": true }, "durationTrafficInSeconds": { - "description": "The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. This value is always provided for the complete route and does not depend on the availability of traffic information.", + "description": "The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. This value is provided if optimizeRoute includes traffic considerations.", "format": "int64", "type": "integer", "readOnly": true @@ -975,7 +975,7 @@ "readOnly": true }, "durationTrafficInSeconds": { - "description": "The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. This value is always provided for the complete route and does not depend on the availability of traffic information.", + "description": "The time that it takes, in seconds, to travel a corresponding TravelDistance with current traffic conditions. This value is provided if optimizeRoute includes traffic considerations.", "format": "int64", "type": "integer", "readOnly": true diff --git a/specification/maps/data-plane/readme.md b/specification/maps/data-plane/readme.md index fe2b8aa34b34..b6e5e96a733f 100644 --- a/specification/maps/data-plane/readme.md +++ b/specification/maps/data-plane/readme.md @@ -51,7 +51,7 @@ These settings apply only when `--tag=package-stable-2023-07-01` is specified on ```yaml $(tag) == 'package-stable-2023-07-01' input-file: - - Common/stable/2023-07-01/common.json + - Common/stable/2023-06-01/common.json - Creator/stable/2023-07-01/alias.json - Creator/stable/2023-07-01/dataset.json - Creator/stable/2023-07-01/dwgconversion.json diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_Get_MaximumSet_Gen.json index a5a68e2f8fd5..f1a6b2273e89 100644 --- a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_Get_MaximumSet_Gen.json +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_Get_MaximumSet_Gen.json @@ -3,11 +3,11 @@ "operationId": "IisWebApplicationsController_Get", "parameters": { "api-version": "2023-06-06", - "subscriptionId": "B91B3C41-A3C4-4A9B-BEA9-936F1C33EA3F", + "subscriptionId": "F4A3C7D3-C4AB-4400-8931-E2DBA0E5DA34", "resourceGroupName": "rgmigrate", - "siteName": "6-7I5Fi-0-1-3Jh7L--6", - "webAppSiteName": "1SnJ6nVswmZ-F-L17u-", - "webApplicationName": "285--2AL-S2" + "siteName": "J7vb06z3-3-5q2DB3bVW4", + "webAppSiteName": "N81g1PJ3dj-JI-3KCv7R", + "webApplicationName": "8Jy7H2--CX1" }, "responses": { "200": { @@ -15,18 +15,18 @@ "properties": { "applications": [ { - "applicationPoolName": "burgxiihza", - "managedPipelineMode": "oejpxogjxakk", - "runtimeVersion": "fxazzasvpc", + "applicationPoolName": "abprrfsmryfysrp", + "managedPipelineMode": "megrjvlxjp", + "runtimeVersion": "pfedonnmmypuoysseu", "enable32BitApiOnWin64": true, "path": { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" }, "directories": [ { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" } ] } @@ -35,106 +35,109 @@ { "isVirtualDirectory": true, "path": { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" }, "directories": [ { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" } ] } ], - "webServerId": "uzrohdyb", - "webServerName": "fpzatfrzjbsnl", - "virtualPath": "zfzjqqpqejquxmjsnxhxgkf", - "physicalPath": "grdcbphawmtomejrjoowipt", + "webServerId": "olkxakxpylmawjpxvyqvabhykjpkvr", + "webServerName": "pe", + "machineArmIds": [ + "pbituobvyvg" + ], + "virtualPath": "agttxxwvjwthvoclmarruwjctaueog", + "physicalPath": "mpksnzg", "bindings": [ { - "protocol": "fngttkyb", - "hostName": "qydghmqbbzveyutdofa", - "port": "aanhmwhbtbpussdaepv", - "ipAddress": "jcqyaawtidcuvngbcfolobguthvct" + "protocol": "mzvedcpco", + "hostName": "vrvzeewrdufdujrskwcrpzquabjs", + "port": "mfexwjtuqfdbghysemzxahzujg", + "ipAddress": "pdwukppcisy" } ], "frameworks": [ { - "name": "ezgoydfudnxmprptlaaxi", - "version": "wywzvpuowxaerwx" + "name": "nqvsgxfgajxdu", + "version": "sjuqzki" } ], "configurations": [ { - "name": "zvsvrvngzmlcuflltnqafwsvpwxzfs", - "filePath": "vljpocynvcjaka", - "localFilePath": "wllg", - "targetFilePath": "bzbhygsvdbb", - "section": "v", - "type": "nllbprrznbbkrkw", + "name": "fujapsbevanbtdqijc", + "filePath": "pnqnhvepc", + "localFilePath": "fazylclscoilzkzwqhyaeqjw", + "targetFilePath": "symewjmneejaaulniyivmzwowbq", + "section": "fwrxpwohoh", + "type": "pmuqrvifkjqguuknwvp", "isDeploymentTimeEditable": true, - "identifier": "kaogmxbzcjd" + "identifier": "kmungxntdzeuf" } ], "directories": [ { - "id": "etzqzimqqiplkdc", + "id": "awnkpdks", "isEditable": true, "sourcePaths": [ - "sfucje" + "ojgkzhyzbylxukdfztkbtvxtnnfmvh" ], - "localScratchPath": "htvqybdroepwfqiyeaprozhrpj", - "mountPath": "ubtugdniedpvlihrfkwzphybdmlwl", - "sourceSize": "uiyeofjwprdg" + "localScratchPath": "oqxpekgyx", + "mountPath": "imrbevkul", + "sourceSize": "uarzydjdouzasjnnx" } ], - "displayName": "fx", + "displayName": "tvjmkklopxgpmqireubwykl", "tags": { - "key5772": "tqyfqeuymacelfopertc" + "key3494": "aisuptprvsfskvcvzfgmwxwvcjvtoh" }, "staticFolders": [ - "zhsyeyhxedfywtjcifxn" + "hbyt" ], - "machineDisplayName": "hdkyrmgmakaznwtpwuqrgjqvnrekqk", + "machineDisplayName": "csmy", "isDeleted": true, - "createdTimestamp": "ysyrrzzt", - "updatedTimestamp": "dpzvwuptydqlxpqcauhnavval", - "serverType": "kgvdirkdhndxkiph", + "createdTimestamp": "humplzmkakaytkgyiiinodugta", + "updatedTimestamp": "jmfj", + "serverType": "hfgsyc", "errors": [ { - "message": "whzrtghfrhmuypkiway", + "message": "rlqnsu", "messageParameters": { - "key6922": "tlcuwdfzhhjxleeqtmlahxba" + "key736": "fuzukesrxdillaj" }, - "applianceName": "lfxolxp", - "id": 26, - "code": "amyfkrkwvziaqwrzvreyscdgtscg", - "possibleCauses": "jvstvosewxjvcqxmodmzx", - "recommendedAction": "lkuzyfhosdyzbin", - "severity": "lek", - "summaryMessage": "tmrblehgylapcamanvr", + "applianceName": "llseidstennfoiltgflblxhfbj", + "id": 11, + "code": "hhdznmtaqhvhz", + "possibleCauses": "f", + "recommendedAction": "mcllhcihkorwqyaadzmqktukah", + "severity": "ke", + "summaryMessage": "kgxaaqsx", "source": "RefreshFabricLayout", - "updatedTimeStamp": "2023-08-21T05:00:01.013Z", - "runAsAccountId": "drikcaihbjhhvzskywytzhhxmhlew", + "updatedTimeStamp": "2023-11-29T09:34:03.225Z", + "runAsAccountId": "ankwgtiuaxhfnqyiqmhwd", "discoveryScope": "AppsAndRoles" } ], "applianceNames": [ - "jkugvyajyvmnndlwrkmudiyiyfpwg" + "qjvgstblrumhvcuelxwxwlvwj" ], "hasErrors": true, "provisioningState": "Created" }, - "id": "fqwfvsexuwlpydtoueoqylnbzc", - "name": "avvwmxihjssjubhn", - "type": "ujtkhagsxzlmh", + "id": "kkmnclgsiarnemepsgcwvrsssxtbo", + "name": "iekrk", + "type": "qkugsqczlzxwwmwjessfrgitxlymc", "systemData": { - "createdBy": "lguj", + "createdBy": "xoellpecudjqgxornwrldlwuu", "createdByType": "User", - "createdAt": "2023-08-21T04:59:22.848Z", - "lastModifiedBy": "ljksfywnicbqrzrcqfk", + "createdAt": "2023-11-29T09:32:59.480Z", + "lastModifiedBy": "vopmszwqhxskyawwxkufcq", "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-21T04:59:22.848Z" + "lastModifiedAt": "2023-11-29T09:32:59.480Z" } } } diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json index 437617efc7c9..27234410787f 100644 --- a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json @@ -2,15 +2,15 @@ "title": "IisWebApplicationsController_ListByWebAppSite", "operationId": "IisWebApplicationsController_ListByWebAppSite", "parameters": { - "subscriptionId": "B91B3C41-A3C4-4A9B-BEA9-936F1C33EA3F", + "subscriptionId": "F4A3C7D3-C4AB-4400-8931-E2DBA0E5DA34", "resourceGroupName": "rgmigrate", "api-version": "2023-06-06", - "filter": "mxfsg", - "top": "vqshavzwierjlkuymdhzp", - "continuationToken": "flukawebngogmoxqblooxzhpkydl", - "totalRecordCount": 25, - "siteName": "91JKy98xU57", - "webAppSiteName": "-8T2P23X-r83RwKYU-R-E-9Q" + "filter": "horqufqxkmjstoznxhizaelmw", + "top": "bgvqi", + "continuationToken": "cysgeivttxdi", + "totalRecordCount": 20, + "siteName": "77A747V2B-Ce-BR2H7-JuY", + "webAppSiteName": "WN27fTy-JX2z7" }, "responses": { "200": { @@ -20,18 +20,18 @@ "properties": { "applications": [ { - "applicationPoolName": "burgxiihza", - "managedPipelineMode": "oejpxogjxakk", - "runtimeVersion": "fxazzasvpc", + "applicationPoolName": "abprrfsmryfysrp", + "managedPipelineMode": "megrjvlxjp", + "runtimeVersion": "pfedonnmmypuoysseu", "enable32BitApiOnWin64": true, "path": { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" }, "directories": [ { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" } ] } @@ -40,110 +40,113 @@ { "isVirtualDirectory": true, "path": { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" }, "directories": [ { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" } ] } ], - "webServerId": "uzrohdyb", - "webServerName": "fpzatfrzjbsnl", - "virtualPath": "zfzjqqpqejquxmjsnxhxgkf", - "physicalPath": "grdcbphawmtomejrjoowipt", + "webServerId": "olkxakxpylmawjpxvyqvabhykjpkvr", + "webServerName": "pe", + "machineArmIds": [ + "pbituobvyvg" + ], + "virtualPath": "agttxxwvjwthvoclmarruwjctaueog", + "physicalPath": "mpksnzg", "bindings": [ { - "protocol": "fngttkyb", - "hostName": "qydghmqbbzveyutdofa", - "port": "aanhmwhbtbpussdaepv", - "ipAddress": "jcqyaawtidcuvngbcfolobguthvct" + "protocol": "mzvedcpco", + "hostName": "vrvzeewrdufdujrskwcrpzquabjs", + "port": "mfexwjtuqfdbghysemzxahzujg", + "ipAddress": "pdwukppcisy" } ], "frameworks": [ { - "name": "ezgoydfudnxmprptlaaxi", - "version": "wywzvpuowxaerwx" + "name": "nqvsgxfgajxdu", + "version": "sjuqzki" } ], "configurations": [ { - "name": "zvsvrvngzmlcuflltnqafwsvpwxzfs", - "filePath": "vljpocynvcjaka", - "localFilePath": "wllg", - "targetFilePath": "bzbhygsvdbb", - "section": "v", - "type": "nllbprrznbbkrkw", + "name": "fujapsbevanbtdqijc", + "filePath": "pnqnhvepc", + "localFilePath": "fazylclscoilzkzwqhyaeqjw", + "targetFilePath": "symewjmneejaaulniyivmzwowbq", + "section": "fwrxpwohoh", + "type": "pmuqrvifkjqguuknwvp", "isDeploymentTimeEditable": true, - "identifier": "kaogmxbzcjd" + "identifier": "kmungxntdzeuf" } ], "directories": [ { - "id": "etzqzimqqiplkdc", + "id": "awnkpdks", "isEditable": true, "sourcePaths": [ - "sfucje" + "ojgkzhyzbylxukdfztkbtvxtnnfmvh" ], - "localScratchPath": "htvqybdroepwfqiyeaprozhrpj", - "mountPath": "ubtugdniedpvlihrfkwzphybdmlwl", - "sourceSize": "uiyeofjwprdg" + "localScratchPath": "oqxpekgyx", + "mountPath": "imrbevkul", + "sourceSize": "uarzydjdouzasjnnx" } ], - "displayName": "fx", + "displayName": "tvjmkklopxgpmqireubwykl", "tags": { - "key5772": "tqyfqeuymacelfopertc" + "key3494": "aisuptprvsfskvcvzfgmwxwvcjvtoh" }, "staticFolders": [ - "zhsyeyhxedfywtjcifxn" + "hbyt" ], - "machineDisplayName": "hdkyrmgmakaznwtpwuqrgjqvnrekqk", + "machineDisplayName": "csmy", "isDeleted": true, - "createdTimestamp": "ysyrrzzt", - "updatedTimestamp": "dpzvwuptydqlxpqcauhnavval", - "serverType": "kgvdirkdhndxkiph", + "createdTimestamp": "humplzmkakaytkgyiiinodugta", + "updatedTimestamp": "jmfj", + "serverType": "hfgsyc", "errors": [ { - "message": "whzrtghfrhmuypkiway", + "message": "rlqnsu", "messageParameters": { - "key6922": "tlcuwdfzhhjxleeqtmlahxba" + "key736": "fuzukesrxdillaj" }, - "applianceName": "lfxolxp", - "id": 26, - "code": "amyfkrkwvziaqwrzvreyscdgtscg", - "possibleCauses": "jvstvosewxjvcqxmodmzx", - "recommendedAction": "lkuzyfhosdyzbin", - "severity": "lek", - "summaryMessage": "tmrblehgylapcamanvr", + "applianceName": "llseidstennfoiltgflblxhfbj", + "id": 11, + "code": "hhdznmtaqhvhz", + "possibleCauses": "f", + "recommendedAction": "mcllhcihkorwqyaadzmqktukah", + "severity": "ke", + "summaryMessage": "kgxaaqsx", "source": "RefreshFabricLayout", - "updatedTimeStamp": "2023-08-21T05:00:01.013Z", - "runAsAccountId": "drikcaihbjhhvzskywytzhhxmhlew", + "updatedTimeStamp": "2023-11-29T09:34:03.225Z", + "runAsAccountId": "ankwgtiuaxhfnqyiqmhwd", "discoveryScope": "AppsAndRoles" } ], "applianceNames": [ - "jkugvyajyvmnndlwrkmudiyiyfpwg" + "qjvgstblrumhvcuelxwxwlvwj" ], "hasErrors": true, "provisioningState": "Created" }, - "id": "fqwfvsexuwlpydtoueoqylnbzc", - "name": "avvwmxihjssjubhn", - "type": "ujtkhagsxzlmh", + "id": "kkmnclgsiarnemepsgcwvrsssxtbo", + "name": "iekrk", + "type": "qkugsqczlzxwwmwjessfrgitxlymc", "systemData": { - "createdBy": "lguj", + "createdBy": "xoellpecudjqgxornwrldlwuu", "createdByType": "User", - "createdAt": "2023-08-21T04:59:22.848Z", - "lastModifiedBy": "ljksfywnicbqrzrcqfk", + "createdAt": "2023-11-29T09:32:59.480Z", + "lastModifiedBy": "vopmszwqhxskyawwxkufcq", "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-21T04:59:22.848Z" + "lastModifiedAt": "2023-11-29T09:32:59.480Z" } } ], - "nextLink": "https://microsoft.com/a" + "nextLink": "https://microsoft.com/ahs" } } } diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_Update_MaximumSet_Gen.json index 24ecea8d8db7..56ed8da399b1 100644 --- a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_Update_MaximumSet_Gen.json +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/IisWebApplicationsController_Update_MaximumSet_Gen.json @@ -3,15 +3,15 @@ "operationId": "IisWebApplicationsController_Update", "parameters": { "api-version": "2023-06-06", - "subscriptionId": "B91B3C41-A3C4-4A9B-BEA9-936F1C33EA3F", + "subscriptionId": "F4A3C7D3-C4AB-4400-8931-E2DBA0E5DA34", "resourceGroupName": "rgmigrate", - "siteName": "ZY1-L3TL7R47tDU-W1Bh7W8", - "webAppSiteName": "-KBo2-T5MXXCy", - "webApplicationName": "Q-FS7D2X-5", + "siteName": "NM11", + "webAppSiteName": "YB0CSXSS7-28-p9-I", + "webApplicationName": "-1Nc2961wZ", "body": { "properties": { "tags": { - "key6576": "sasikhgomexejsgnhfpf" + "key9542": "rhpptnmplnhqrj" } } } @@ -22,18 +22,18 @@ "properties": { "applications": [ { - "applicationPoolName": "burgxiihza", - "managedPipelineMode": "oejpxogjxakk", - "runtimeVersion": "fxazzasvpc", + "applicationPoolName": "abprrfsmryfysrp", + "managedPipelineMode": "megrjvlxjp", + "runtimeVersion": "pfedonnmmypuoysseu", "enable32BitApiOnWin64": true, "path": { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" }, "directories": [ { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" } ] } @@ -42,106 +42,109 @@ { "isVirtualDirectory": true, "path": { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" }, "directories": [ { - "virtual": "eehayhsaltbyzpfdumcksrkmkfjwme", - "physical": "vppvnuddunbgthybapnkwh" + "virtual": "kbthlvxgruupzqjyqabzghewtpyy", + "physical": "kdwavzgeiityrazrzqwncjsnlufl" } ] } ], - "webServerId": "uzrohdyb", - "webServerName": "fpzatfrzjbsnl", - "virtualPath": "zfzjqqpqejquxmjsnxhxgkf", - "physicalPath": "grdcbphawmtomejrjoowipt", + "webServerId": "olkxakxpylmawjpxvyqvabhykjpkvr", + "webServerName": "pe", + "machineArmIds": [ + "pbituobvyvg" + ], + "virtualPath": "agttxxwvjwthvoclmarruwjctaueog", + "physicalPath": "mpksnzg", "bindings": [ { - "protocol": "fngttkyb", - "hostName": "qydghmqbbzveyutdofa", - "port": "aanhmwhbtbpussdaepv", - "ipAddress": "jcqyaawtidcuvngbcfolobguthvct" + "protocol": "mzvedcpco", + "hostName": "vrvzeewrdufdujrskwcrpzquabjs", + "port": "mfexwjtuqfdbghysemzxahzujg", + "ipAddress": "pdwukppcisy" } ], "frameworks": [ { - "name": "ezgoydfudnxmprptlaaxi", - "version": "wywzvpuowxaerwx" + "name": "nqvsgxfgajxdu", + "version": "sjuqzki" } ], "configurations": [ { - "name": "zvsvrvngzmlcuflltnqafwsvpwxzfs", - "filePath": "vljpocynvcjaka", - "localFilePath": "wllg", - "targetFilePath": "bzbhygsvdbb", - "section": "v", - "type": "nllbprrznbbkrkw", + "name": "fujapsbevanbtdqijc", + "filePath": "pnqnhvepc", + "localFilePath": "fazylclscoilzkzwqhyaeqjw", + "targetFilePath": "symewjmneejaaulniyivmzwowbq", + "section": "fwrxpwohoh", + "type": "pmuqrvifkjqguuknwvp", "isDeploymentTimeEditable": true, - "identifier": "kaogmxbzcjd" + "identifier": "kmungxntdzeuf" } ], "directories": [ { - "id": "etzqzimqqiplkdc", + "id": "awnkpdks", "isEditable": true, "sourcePaths": [ - "sfucje" + "ojgkzhyzbylxukdfztkbtvxtnnfmvh" ], - "localScratchPath": "htvqybdroepwfqiyeaprozhrpj", - "mountPath": "ubtugdniedpvlihrfkwzphybdmlwl", - "sourceSize": "uiyeofjwprdg" + "localScratchPath": "oqxpekgyx", + "mountPath": "imrbevkul", + "sourceSize": "uarzydjdouzasjnnx" } ], - "displayName": "fx", + "displayName": "tvjmkklopxgpmqireubwykl", "tags": { - "key5772": "tqyfqeuymacelfopertc" + "key3494": "aisuptprvsfskvcvzfgmwxwvcjvtoh" }, "staticFolders": [ - "zhsyeyhxedfywtjcifxn" + "hbyt" ], - "machineDisplayName": "hdkyrmgmakaznwtpwuqrgjqvnrekqk", + "machineDisplayName": "csmy", "isDeleted": true, - "createdTimestamp": "ysyrrzzt", - "updatedTimestamp": "dpzvwuptydqlxpqcauhnavval", - "serverType": "kgvdirkdhndxkiph", + "createdTimestamp": "humplzmkakaytkgyiiinodugta", + "updatedTimestamp": "jmfj", + "serverType": "hfgsyc", "errors": [ { - "message": "whzrtghfrhmuypkiway", + "message": "rlqnsu", "messageParameters": { - "key6922": "tlcuwdfzhhjxleeqtmlahxba" + "key736": "fuzukesrxdillaj" }, - "applianceName": "lfxolxp", - "id": 26, - "code": "amyfkrkwvziaqwrzvreyscdgtscg", - "possibleCauses": "jvstvosewxjvcqxmodmzx", - "recommendedAction": "lkuzyfhosdyzbin", - "severity": "lek", - "summaryMessage": "tmrblehgylapcamanvr", + "applianceName": "llseidstennfoiltgflblxhfbj", + "id": 11, + "code": "hhdznmtaqhvhz", + "possibleCauses": "f", + "recommendedAction": "mcllhcihkorwqyaadzmqktukah", + "severity": "ke", + "summaryMessage": "kgxaaqsx", "source": "RefreshFabricLayout", - "updatedTimeStamp": "2023-08-21T05:00:01.013Z", - "runAsAccountId": "drikcaihbjhhvzskywytzhhxmhlew", + "updatedTimeStamp": "2023-11-29T09:34:03.225Z", + "runAsAccountId": "ankwgtiuaxhfnqyiqmhwd", "discoveryScope": "AppsAndRoles" } ], "applianceNames": [ - "jkugvyajyvmnndlwrkmudiyiyfpwg" + "qjvgstblrumhvcuelxwxwlvwj" ], "hasErrors": true, "provisioningState": "Created" }, - "id": "fqwfvsexuwlpydtoueoqylnbzc", - "name": "avvwmxihjssjubhn", - "type": "ujtkhagsxzlmh", + "id": "kkmnclgsiarnemepsgcwvrsssxtbo", + "name": "iekrk", + "type": "qkugsqczlzxwwmwjessfrgitxlymc", "systemData": { - "createdBy": "lguj", + "createdBy": "xoellpecudjqgxornwrldlwuu", "createdByType": "User", - "createdAt": "2023-08-21T04:59:22.848Z", - "lastModifiedBy": "ljksfywnicbqrzrcqfk", + "createdAt": "2023-11-29T09:32:59.480Z", + "lastModifiedBy": "vopmszwqhxskyawwxkufcq", "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-21T04:59:22.848Z" + "lastModifiedAt": "2023-11-29T09:32:59.480Z" } } } diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_Get_MaximumSet_Gen.json index 73a6caf44ff9..ab5c492acbb6 100644 --- a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_Get_MaximumSet_Gen.json +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_Get_MaximumSet_Gen.json @@ -3,11 +3,11 @@ "operationId": "TomcatWebApplicationsController_Get", "parameters": { "api-version": "2023-06-06", - "subscriptionId": "B91B3C41-A3C4-4A9B-BEA9-936F1C33EA3F", + "subscriptionId": "F4A3C7D3-C4AB-4400-8931-E2DBA0E5DA34", "resourceGroupName": "rgmigrate", - "siteName": "-I1XwV-0--N-s3-Hl4wC865", - "webAppSiteName": "8t8Y45q3l1JC-8MT-24-", - "webApplicationName": "4Y00j7w-Wl1tWhrHl" + "siteName": "lBYit-iOl6-U", + "webAppSiteName": "44-l", + "webApplicationName": "9-0N--SMKPUFgr" }, "responses": { "200": { @@ -15,95 +15,98 @@ "properties": { "hasDatabaseDependency": true, "isExternalLoggingConfigured": true, - "webServerId": "szauhhuyilzobujjhexzuqiaesie", - "webServerName": "gjxjiempxtegwevmikynkj", - "virtualPath": "gjwpktwy", - "physicalPath": "icphfjhecho", + "webServerId": "mjkitphplujocpu", + "webServerName": "hguhxhpbnkbcn", + "machineArmIds": [ + "lrbwysitecnfyiluzvb" + ], + "virtualPath": "xnrcprspd", + "physicalPath": "qrdpknaqhdxy", "bindings": [ { - "protocol": "fngttkyb", - "hostName": "qydghmqbbzveyutdofa", - "port": "aanhmwhbtbpussdaepv", - "ipAddress": "jcqyaawtidcuvngbcfolobguthvct" + "protocol": "mzvedcpco", + "hostName": "vrvzeewrdufdujrskwcrpzquabjs", + "port": "mfexwjtuqfdbghysemzxahzujg", + "ipAddress": "pdwukppcisy" } ], "frameworks": [ { - "name": "ezgoydfudnxmprptlaaxi", - "version": "wywzvpuowxaerwx" + "name": "nqvsgxfgajxdu", + "version": "sjuqzki" } ], "configurations": [ { - "name": "zvsvrvngzmlcuflltnqafwsvpwxzfs", - "filePath": "vljpocynvcjaka", - "localFilePath": "wllg", - "targetFilePath": "bzbhygsvdbb", - "section": "v", - "type": "nllbprrznbbkrkw", + "name": "fujapsbevanbtdqijc", + "filePath": "pnqnhvepc", + "localFilePath": "fazylclscoilzkzwqhyaeqjw", + "targetFilePath": "symewjmneejaaulniyivmzwowbq", + "section": "fwrxpwohoh", + "type": "pmuqrvifkjqguuknwvp", "isDeploymentTimeEditable": true, - "identifier": "kaogmxbzcjd" + "identifier": "kmungxntdzeuf" } ], "directories": [ { - "id": "etzqzimqqiplkdc", + "id": "awnkpdks", "isEditable": true, "sourcePaths": [ - "sfucje" + "ojgkzhyzbylxukdfztkbtvxtnnfmvh" ], - "localScratchPath": "htvqybdroepwfqiyeaprozhrpj", - "mountPath": "ubtugdniedpvlihrfkwzphybdmlwl", - "sourceSize": "uiyeofjwprdg" + "localScratchPath": "oqxpekgyx", + "mountPath": "imrbevkul", + "sourceSize": "uarzydjdouzasjnnx" } ], - "displayName": "uiyjhkjhrqaefxoggfwmrcsscmewzj", + "displayName": "ggkehulnhfzmblo", "tags": { - "key2051": "pqucah" + "key2725": "vxnrbkypuugwdcwncc" }, "staticFolders": [ - "jssjbvhfjwuagbvy" + "hnclhyndfbisqoscqdfgovma" ], - "machineDisplayName": "ikvtzm", + "machineDisplayName": "eehqmsndwamzdairaqhmdy", "isDeleted": true, - "createdTimestamp": "meq", - "updatedTimestamp": "msgfmjdneggbgtppqtymnygff", - "serverType": "duutxr", + "createdTimestamp": "nlsuznhojownfmxd", + "updatedTimestamp": "ldyipyvypjdbasl", + "serverType": "yxtyqr", "errors": [ { - "message": "whzrtghfrhmuypkiway", + "message": "rlqnsu", "messageParameters": { - "key6922": "tlcuwdfzhhjxleeqtmlahxba" + "key736": "fuzukesrxdillaj" }, - "applianceName": "lfxolxp", - "id": 26, - "code": "amyfkrkwvziaqwrzvreyscdgtscg", - "possibleCauses": "jvstvosewxjvcqxmodmzx", - "recommendedAction": "lkuzyfhosdyzbin", - "severity": "lek", - "summaryMessage": "tmrblehgylapcamanvr", + "applianceName": "llseidstennfoiltgflblxhfbj", + "id": 11, + "code": "hhdznmtaqhvhz", + "possibleCauses": "f", + "recommendedAction": "mcllhcihkorwqyaadzmqktukah", + "severity": "ke", + "summaryMessage": "kgxaaqsx", "source": "RefreshFabricLayout", - "updatedTimeStamp": "2023-08-21T05:00:01.013Z", - "runAsAccountId": "drikcaihbjhhvzskywytzhhxmhlew", + "updatedTimeStamp": "2023-11-29T09:34:03.225Z", + "runAsAccountId": "ankwgtiuaxhfnqyiqmhwd", "discoveryScope": "AppsAndRoles" } ], "applianceNames": [ - "xwcamabxukllishnmda" + "ri" ], "hasErrors": true, "provisioningState": "Created" }, - "id": "xacqzbyikowv", - "name": "ixddvmlrvrjl", - "type": "czmbxesjdjpwdbzxhmvaerofo", + "id": "vltnlstcuywugqwbqeuoqukicsn", + "name": "sszngssjyckm", + "type": "esbubsuntgftwh", "systemData": { - "createdBy": "lguj", + "createdBy": "xoellpecudjqgxornwrldlwuu", "createdByType": "User", - "createdAt": "2023-08-21T04:59:22.848Z", - "lastModifiedBy": "ljksfywnicbqrzrcqfk", + "createdAt": "2023-11-29T09:32:59.480Z", + "lastModifiedBy": "vopmszwqhxskyawwxkufcq", "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-21T04:59:22.848Z" + "lastModifiedAt": "2023-11-29T09:32:59.480Z" } } } diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json index a2bfbd21e335..699402f7f57c 100644 --- a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json @@ -2,15 +2,15 @@ "title": "TomcatWebApplicationsController_ListByWebAppSite", "operationId": "TomcatWebApplicationsController_ListByWebAppSite", "parameters": { - "subscriptionId": "B91B3C41-A3C4-4A9B-BEA9-936F1C33EA3F", + "subscriptionId": "F4A3C7D3-C4AB-4400-8931-E2DBA0E5DA34", "resourceGroupName": "rgmigrate", "api-version": "2023-06-06", - "filter": "wzkkiurhj", - "top": "cnifojn", - "continuationToken": "hyrkbboxjgwnf", - "totalRecordCount": 18, - "siteName": "6AW-37o", - "webAppSiteName": "776---5-l-b" + "filter": "sfonumsziyhnu", + "top": "wwuvdi", + "continuationToken": "xhrniguygvo", + "totalRecordCount": 9, + "siteName": "---7-", + "webAppSiteName": "-R-vt-B--y-RH60-bJ7K7-" }, "responses": { "200": { @@ -20,95 +20,98 @@ "properties": { "hasDatabaseDependency": true, "isExternalLoggingConfigured": true, - "webServerId": "szauhhuyilzobujjhexzuqiaesie", - "webServerName": "gjxjiempxtegwevmikynkj", - "virtualPath": "gjwpktwy", - "physicalPath": "icphfjhecho", + "webServerId": "mjkitphplujocpu", + "webServerName": "hguhxhpbnkbcn", + "machineArmIds": [ + "lrbwysitecnfyiluzvb" + ], + "virtualPath": "xnrcprspd", + "physicalPath": "qrdpknaqhdxy", "bindings": [ { - "protocol": "fngttkyb", - "hostName": "qydghmqbbzveyutdofa", - "port": "aanhmwhbtbpussdaepv", - "ipAddress": "jcqyaawtidcuvngbcfolobguthvct" + "protocol": "mzvedcpco", + "hostName": "vrvzeewrdufdujrskwcrpzquabjs", + "port": "mfexwjtuqfdbghysemzxahzujg", + "ipAddress": "pdwukppcisy" } ], "frameworks": [ { - "name": "ezgoydfudnxmprptlaaxi", - "version": "wywzvpuowxaerwx" + "name": "nqvsgxfgajxdu", + "version": "sjuqzki" } ], "configurations": [ { - "name": "zvsvrvngzmlcuflltnqafwsvpwxzfs", - "filePath": "vljpocynvcjaka", - "localFilePath": "wllg", - "targetFilePath": "bzbhygsvdbb", - "section": "v", - "type": "nllbprrznbbkrkw", + "name": "fujapsbevanbtdqijc", + "filePath": "pnqnhvepc", + "localFilePath": "fazylclscoilzkzwqhyaeqjw", + "targetFilePath": "symewjmneejaaulniyivmzwowbq", + "section": "fwrxpwohoh", + "type": "pmuqrvifkjqguuknwvp", "isDeploymentTimeEditable": true, - "identifier": "kaogmxbzcjd" + "identifier": "kmungxntdzeuf" } ], "directories": [ { - "id": "etzqzimqqiplkdc", + "id": "awnkpdks", "isEditable": true, "sourcePaths": [ - "sfucje" + "ojgkzhyzbylxukdfztkbtvxtnnfmvh" ], - "localScratchPath": "htvqybdroepwfqiyeaprozhrpj", - "mountPath": "ubtugdniedpvlihrfkwzphybdmlwl", - "sourceSize": "uiyeofjwprdg" + "localScratchPath": "oqxpekgyx", + "mountPath": "imrbevkul", + "sourceSize": "uarzydjdouzasjnnx" } ], - "displayName": "uiyjhkjhrqaefxoggfwmrcsscmewzj", + "displayName": "ggkehulnhfzmblo", "tags": { - "key2051": "pqucah" + "key2725": "vxnrbkypuugwdcwncc" }, "staticFolders": [ - "jssjbvhfjwuagbvy" + "hnclhyndfbisqoscqdfgovma" ], - "machineDisplayName": "ikvtzm", + "machineDisplayName": "eehqmsndwamzdairaqhmdy", "isDeleted": true, - "createdTimestamp": "meq", - "updatedTimestamp": "msgfmjdneggbgtppqtymnygff", - "serverType": "duutxr", + "createdTimestamp": "nlsuznhojownfmxd", + "updatedTimestamp": "ldyipyvypjdbasl", + "serverType": "yxtyqr", "errors": [ { - "message": "whzrtghfrhmuypkiway", + "message": "rlqnsu", "messageParameters": { - "key6922": "tlcuwdfzhhjxleeqtmlahxba" + "key736": "fuzukesrxdillaj" }, - "applianceName": "lfxolxp", - "id": 26, - "code": "amyfkrkwvziaqwrzvreyscdgtscg", - "possibleCauses": "jvstvosewxjvcqxmodmzx", - "recommendedAction": "lkuzyfhosdyzbin", - "severity": "lek", - "summaryMessage": "tmrblehgylapcamanvr", + "applianceName": "llseidstennfoiltgflblxhfbj", + "id": 11, + "code": "hhdznmtaqhvhz", + "possibleCauses": "f", + "recommendedAction": "mcllhcihkorwqyaadzmqktukah", + "severity": "ke", + "summaryMessage": "kgxaaqsx", "source": "RefreshFabricLayout", - "updatedTimeStamp": "2023-08-21T05:00:01.013Z", - "runAsAccountId": "drikcaihbjhhvzskywytzhhxmhlew", + "updatedTimeStamp": "2023-11-29T09:34:03.225Z", + "runAsAccountId": "ankwgtiuaxhfnqyiqmhwd", "discoveryScope": "AppsAndRoles" } ], "applianceNames": [ - "xwcamabxukllishnmda" + "ri" ], "hasErrors": true, "provisioningState": "Created" }, - "id": "xacqzbyikowv", - "name": "ixddvmlrvrjl", - "type": "czmbxesjdjpwdbzxhmvaerofo", + "id": "vltnlstcuywugqwbqeuoqukicsn", + "name": "sszngssjyckm", + "type": "esbubsuntgftwh", "systemData": { - "createdBy": "lguj", + "createdBy": "xoellpecudjqgxornwrldlwuu", "createdByType": "User", - "createdAt": "2023-08-21T04:59:22.848Z", - "lastModifiedBy": "ljksfywnicbqrzrcqfk", + "createdAt": "2023-11-29T09:32:59.480Z", + "lastModifiedBy": "vopmszwqhxskyawwxkufcq", "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-21T04:59:22.848Z" + "lastModifiedAt": "2023-11-29T09:32:59.480Z" } } ], diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_Update_MaximumSet_Gen.json index 8afb45452c14..366b5d3f7645 100644 --- a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_Update_MaximumSet_Gen.json +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/TomcatWebApplicationsController_Update_MaximumSet_Gen.json @@ -3,11 +3,11 @@ "operationId": "TomcatWebApplicationsController_Update", "parameters": { "api-version": "2023-06-06", - "subscriptionId": "B91B3C41-A3C4-4A9B-BEA9-936F1C33EA3F", + "subscriptionId": "F4A3C7D3-C4AB-4400-8931-E2DBA0E5DA34", "resourceGroupName": "rgmigrate", - "siteName": "Ev-6W8ZUALP", - "webAppSiteName": "e-EPeP7--9-K-10Y6-", - "webApplicationName": "b72DEB7ML2JW7JSERR8-kK", + "siteName": "-VXRq7C-247NQ-bnEZQ-Q7U", + "webAppSiteName": "--f7x69RFDKJujRI3", + "webApplicationName": "Q1-5rFEHTX", "body": {} }, "responses": { @@ -16,95 +16,98 @@ "properties": { "hasDatabaseDependency": true, "isExternalLoggingConfigured": true, - "webServerId": "szauhhuyilzobujjhexzuqiaesie", - "webServerName": "gjxjiempxtegwevmikynkj", - "virtualPath": "gjwpktwy", - "physicalPath": "icphfjhecho", + "webServerId": "mjkitphplujocpu", + "webServerName": "hguhxhpbnkbcn", + "machineArmIds": [ + "lrbwysitecnfyiluzvb" + ], + "virtualPath": "xnrcprspd", + "physicalPath": "qrdpknaqhdxy", "bindings": [ { - "protocol": "fngttkyb", - "hostName": "qydghmqbbzveyutdofa", - "port": "aanhmwhbtbpussdaepv", - "ipAddress": "jcqyaawtidcuvngbcfolobguthvct" + "protocol": "mzvedcpco", + "hostName": "vrvzeewrdufdujrskwcrpzquabjs", + "port": "mfexwjtuqfdbghysemzxahzujg", + "ipAddress": "pdwukppcisy" } ], "frameworks": [ { - "name": "ezgoydfudnxmprptlaaxi", - "version": "wywzvpuowxaerwx" + "name": "nqvsgxfgajxdu", + "version": "sjuqzki" } ], "configurations": [ { - "name": "zvsvrvngzmlcuflltnqafwsvpwxzfs", - "filePath": "vljpocynvcjaka", - "localFilePath": "wllg", - "targetFilePath": "bzbhygsvdbb", - "section": "v", - "type": "nllbprrznbbkrkw", + "name": "fujapsbevanbtdqijc", + "filePath": "pnqnhvepc", + "localFilePath": "fazylclscoilzkzwqhyaeqjw", + "targetFilePath": "symewjmneejaaulniyivmzwowbq", + "section": "fwrxpwohoh", + "type": "pmuqrvifkjqguuknwvp", "isDeploymentTimeEditable": true, - "identifier": "kaogmxbzcjd" + "identifier": "kmungxntdzeuf" } ], "directories": [ { - "id": "etzqzimqqiplkdc", + "id": "awnkpdks", "isEditable": true, "sourcePaths": [ - "sfucje" + "ojgkzhyzbylxukdfztkbtvxtnnfmvh" ], - "localScratchPath": "htvqybdroepwfqiyeaprozhrpj", - "mountPath": "ubtugdniedpvlihrfkwzphybdmlwl", - "sourceSize": "uiyeofjwprdg" + "localScratchPath": "oqxpekgyx", + "mountPath": "imrbevkul", + "sourceSize": "uarzydjdouzasjnnx" } ], - "displayName": "uiyjhkjhrqaefxoggfwmrcsscmewzj", + "displayName": "ggkehulnhfzmblo", "tags": { - "key2051": "pqucah" + "key2725": "vxnrbkypuugwdcwncc" }, "staticFolders": [ - "jssjbvhfjwuagbvy" + "hnclhyndfbisqoscqdfgovma" ], - "machineDisplayName": "ikvtzm", + "machineDisplayName": "eehqmsndwamzdairaqhmdy", "isDeleted": true, - "createdTimestamp": "meq", - "updatedTimestamp": "msgfmjdneggbgtppqtymnygff", - "serverType": "duutxr", + "createdTimestamp": "nlsuznhojownfmxd", + "updatedTimestamp": "ldyipyvypjdbasl", + "serverType": "yxtyqr", "errors": [ { - "message": "whzrtghfrhmuypkiway", + "message": "rlqnsu", "messageParameters": { - "key6922": "tlcuwdfzhhjxleeqtmlahxba" + "key736": "fuzukesrxdillaj" }, - "applianceName": "lfxolxp", - "id": 26, - "code": "amyfkrkwvziaqwrzvreyscdgtscg", - "possibleCauses": "jvstvosewxjvcqxmodmzx", - "recommendedAction": "lkuzyfhosdyzbin", - "severity": "lek", - "summaryMessage": "tmrblehgylapcamanvr", + "applianceName": "llseidstennfoiltgflblxhfbj", + "id": 11, + "code": "hhdznmtaqhvhz", + "possibleCauses": "f", + "recommendedAction": "mcllhcihkorwqyaadzmqktukah", + "severity": "ke", + "summaryMessage": "kgxaaqsx", "source": "RefreshFabricLayout", - "updatedTimeStamp": "2023-08-21T05:00:01.013Z", - "runAsAccountId": "drikcaihbjhhvzskywytzhhxmhlew", + "updatedTimeStamp": "2023-11-29T09:34:03.225Z", + "runAsAccountId": "ankwgtiuaxhfnqyiqmhwd", "discoveryScope": "AppsAndRoles" } ], "applianceNames": [ - "xwcamabxukllishnmda" + "ri" ], "hasErrors": true, "provisioningState": "Created" }, - "id": "xacqzbyikowv", - "name": "ixddvmlrvrjl", - "type": "czmbxesjdjpwdbzxhmvaerofo", + "id": "vltnlstcuywugqwbqeuoqukicsn", + "name": "sszngssjyckm", + "type": "esbubsuntgftwh", "systemData": { - "createdBy": "lguj", + "createdBy": "xoellpecudjqgxornwrldlwuu", "createdByType": "User", - "createdAt": "2023-08-21T04:59:22.848Z", - "lastModifiedBy": "ljksfywnicbqrzrcqfk", + "createdAt": "2023-11-29T09:32:59.480Z", + "lastModifiedBy": "vopmszwqhxskyawwxkufcq", "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-21T04:59:22.848Z" + "lastModifiedAt": "2023-11-29T09:32:59.480Z" } } } diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/WebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/WebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json index eba738bd9417..e9dd7f3bbf85 100644 --- a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/WebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/examples/WebApplicationsController_ListByWebAppSite_MaximumSet_Gen.json @@ -2,15 +2,15 @@ "title": "WebApplicationsController_ListByWebAppSite", "operationId": "WebApplicationsController_ListByWebAppSite", "parameters": { - "subscriptionId": "B91B3C41-A3C4-4A9B-BEA9-936F1C33EA3F", + "subscriptionId": "F4A3C7D3-C4AB-4400-8931-E2DBA0E5DA34", "resourceGroupName": "rgmigrate", "api-version": "2023-06-06", - "filter": "nyinjj", - "top": "xvslji", - "continuationToken": "lzamnulfqvnodclttpcnhppmh", - "totalRecordCount": 14, - "siteName": "6656UYYcr153hH08", - "webAppSiteName": "uG666A30738Dyd3p" + "filter": "bjw", + "top": "bnmiivqzqgr", + "continuationToken": "bive", + "totalRecordCount": 29, + "siteName": "-E-y-E7-D14shBi7-30HH6-", + "webAppSiteName": "2F23-bB34SY58YV" }, "responses": { "200": { @@ -18,95 +18,98 @@ "value": [ { "properties": { - "webServerId": "yicvyfflru", - "webServerName": "pojoizyjhzkkeqapghwmi", - "virtualPath": "hayhzlxlluftbjferwmaycpbhijvg", - "physicalPath": "ppiiiva", + "webServerId": "ovsnwwlfdyyrvcpiedk", + "webServerName": "jqk", + "machineArmIds": [ + "spcehdvdurbtkldlml" + ], + "virtualPath": "c", + "physicalPath": "jiycfsnchfmkcnpfwwhrou", "bindings": [ { - "protocol": "fngttkyb", - "hostName": "qydghmqbbzveyutdofa", - "port": "aanhmwhbtbpussdaepv", - "ipAddress": "jcqyaawtidcuvngbcfolobguthvct" + "protocol": "mzvedcpco", + "hostName": "vrvzeewrdufdujrskwcrpzquabjs", + "port": "mfexwjtuqfdbghysemzxahzujg", + "ipAddress": "pdwukppcisy" } ], "frameworks": [ { - "name": "ezgoydfudnxmprptlaaxi", - "version": "wywzvpuowxaerwx" + "name": "nqvsgxfgajxdu", + "version": "sjuqzki" } ], "configurations": [ { - "name": "zvsvrvngzmlcuflltnqafwsvpwxzfs", - "filePath": "vljpocynvcjaka", - "localFilePath": "wllg", - "targetFilePath": "bzbhygsvdbb", - "section": "v", - "type": "nllbprrznbbkrkw", + "name": "fujapsbevanbtdqijc", + "filePath": "pnqnhvepc", + "localFilePath": "fazylclscoilzkzwqhyaeqjw", + "targetFilePath": "symewjmneejaaulniyivmzwowbq", + "section": "fwrxpwohoh", + "type": "pmuqrvifkjqguuknwvp", "isDeploymentTimeEditable": true, - "identifier": "kaogmxbzcjd" + "identifier": "kmungxntdzeuf" } ], "directories": [ { - "id": "etzqzimqqiplkdc", + "id": "awnkpdks", "isEditable": true, "sourcePaths": [ - "sfucje" + "ojgkzhyzbylxukdfztkbtvxtnnfmvh" ], - "localScratchPath": "htvqybdroepwfqiyeaprozhrpj", - "mountPath": "ubtugdniedpvlihrfkwzphybdmlwl", - "sourceSize": "uiyeofjwprdg" + "localScratchPath": "oqxpekgyx", + "mountPath": "imrbevkul", + "sourceSize": "uarzydjdouzasjnnx" } ], - "displayName": "hdhslocejisaasbcbnll", + "displayName": "obdpycnpabwvoda", "tags": { - "key606": "xoofzuvyidmspo" + "key1925": "kxdqicxdeifnbvon" }, "staticFolders": [ - "qiuxualveyhw" + "zaqmqjxxbvemhxqxyyae" ], - "machineDisplayName": "abssmn", + "machineDisplayName": "ynx", "isDeleted": true, - "createdTimestamp": "pxafvupclklugpvwcplofzdh", - "updatedTimestamp": "n", - "serverType": "czxdsahhwwxrvnkmhylbkhggpds", + "createdTimestamp": "vkpkawnrdwvuhrealallaaatdqq", + "updatedTimestamp": "yxmqvhshmmxppad", + "serverType": "tcduhtixeiizppfynuksqs", "errors": [ { - "message": "whzrtghfrhmuypkiway", + "message": "rlqnsu", "messageParameters": { - "key6922": "tlcuwdfzhhjxleeqtmlahxba" + "key736": "fuzukesrxdillaj" }, - "applianceName": "lfxolxp", - "id": 26, - "code": "amyfkrkwvziaqwrzvreyscdgtscg", - "possibleCauses": "jvstvosewxjvcqxmodmzx", - "recommendedAction": "lkuzyfhosdyzbin", - "severity": "lek", - "summaryMessage": "tmrblehgylapcamanvr", + "applianceName": "llseidstennfoiltgflblxhfbj", + "id": 11, + "code": "hhdznmtaqhvhz", + "possibleCauses": "f", + "recommendedAction": "mcllhcihkorwqyaadzmqktukah", + "severity": "ke", + "summaryMessage": "kgxaaqsx", "source": "RefreshFabricLayout", - "updatedTimeStamp": "2023-08-21T05:00:01.013Z", - "runAsAccountId": "drikcaihbjhhvzskywytzhhxmhlew", + "updatedTimeStamp": "2023-11-29T09:34:03.225Z", + "runAsAccountId": "ankwgtiuaxhfnqyiqmhwd", "discoveryScope": "AppsAndRoles" } ], "applianceNames": [ - "nnmowqaii" + "lmkdudx" ], "hasErrors": true, "provisioningState": "Created" }, - "id": "woopdrpkzqyuysjpnp", - "name": "dnr", - "type": "aumwmxvjdxyfcnboq", + "id": "lhxdvgzmliklnfgtmsjpgifs", + "name": "rhrligfkoeavfojlajorpbkfclbojb", + "type": "ntvnikfjduihltpoja", "systemData": { - "createdBy": "lguj", + "createdBy": "xoellpecudjqgxornwrldlwuu", "createdByType": "User", - "createdAt": "2023-08-21T04:59:22.848Z", - "lastModifiedBy": "ljksfywnicbqrzrcqfk", + "createdAt": "2023-11-29T09:32:59.480Z", + "lastModifiedBy": "vopmszwqhxskyawwxkufcq", "lastModifiedByType": "User", - "lastModifiedAt": "2023-08-21T04:59:22.848Z" + "lastModifiedAt": "2023-11-29T09:32:59.480Z" } } ], diff --git a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/migrate.json b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/migrate.json index 3fe6325fdd53..4480e87c98e1 100644 --- a/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/migrate.json +++ b/specification/migrate/resource-manager/Microsoft.OffAzure/stable/2023-06-06/migrate.json @@ -205,10 +205,10 @@ "paths": { "/providers/Microsoft.OffAzure/operations": { "get": { + "operationId": "Operations_List", "tags": [ "Operations" ], - "operationId": "Operations_List", "description": "List the operations for the provider", "parameters": [ { @@ -244,10 +244,10 @@ }, "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/hypervSites": { "get": { + "operationId": "HypervSites_ListBySubscription", "tags": [ "HypervSites" ], - "operationId": "HypervSites_ListBySubscription", "summary": "Get all hyperv sites.", "description": "Get all the hyperv sites in the subscription.", "parameters": [ @@ -287,10 +287,10 @@ }, "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/importSites": { "get": { + "operationId": "ImportSitesController_ListBySubscription", "tags": [ "ImportSitesController" ], - "operationId": "ImportSitesController_ListBySubscription", "description": "List ImportSite resources by subscription ID", "parameters": [ { @@ -329,10 +329,10 @@ }, "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/masterSites": { "get": { + "operationId": "MasterSitesController_ListBySubscription", "tags": [ "MasterSitesController" ], - "operationId": "MasterSitesController_ListBySubscription", "summary": "Get all the sites in the subscription.", "description": "List MasterSite resources by subscription ID", "parameters": [ @@ -372,10 +372,10 @@ }, "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/serverSites": { "get": { + "operationId": "ServerSitesController_ListBySubscription", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_ListBySubscription", "description": "List ServerSiteResource resources by subscription ID", "parameters": [ { @@ -414,10 +414,10 @@ }, "/subscriptions/{subscriptionId}/providers/Microsoft.OffAzure/vmwareSites": { "get": { + "operationId": "SitesController_ListBySubscription", "tags": [ "SitesController" ], - "operationId": "SitesController_ListBySubscription", "summary": "Get all vmware sites.", "description": "Get all the vmware sites in the subscription.", "parameters": [ @@ -457,10 +457,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites": { "get": { + "operationId": "HypervSites_ListByResourceGroup", "tags": [ "HypervSites" ], - "operationId": "HypervSites_ListByResourceGroup", "summary": "Get all hyperv sites.", "description": "Get all the hyperv sites in the subscription.", "parameters": [ @@ -503,10 +503,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}": { "get": { + "operationId": "HypervSitesController_Get", "tags": [ "HypervSitesController" ], - "operationId": "HypervSitesController_Get", "description": "Get a HypervSite", "parameters": [ { @@ -521,8 +521,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -551,10 +551,10 @@ } }, "put": { + "operationId": "HypervSitesController_Create", "tags": [ "HypervSitesController" ], - "operationId": "HypervSitesController_Create", "description": "Create a HypervSite", "parameters": [ { @@ -569,16 +569,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/HypervSite" } @@ -593,15 +593,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervSite" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/HypervSite" } }, "default": { @@ -621,10 +621,10 @@ } }, "patch": { + "operationId": "HypervSitesController_Update", "tags": [ "HypervSitesController" ], - "operationId": "HypervSitesController_Update", "description": "Update a HypervSite", "parameters": [ { @@ -639,16 +639,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/HypervSiteUpdate" } @@ -678,10 +678,10 @@ } }, "delete": { + "operationId": "HypervSitesController_Delete", "tags": [ "HypervSitesController" ], - "operationId": "HypervSitesController_Delete", "description": "Delete a HypervSite", "parameters": [ { @@ -696,8 +696,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -728,10 +728,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clientGroupMembers": { "post": { + "operationId": "HypervDependencyMapController_ClientGroupMembers", "tags": [ "HypervDependencyMapController" ], - "operationId": "HypervDependencyMapController_ClientGroupMembers", "description": "API to list client group members for the selected client group.", "parameters": [ { @@ -746,16 +746,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsClientGroupMembersRequest" } @@ -765,22 +765,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -807,10 +805,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters": { "get": { + "operationId": "HypervClusterController_ListByHypervSite", "tags": [ "HypervClusterController" ], - "operationId": "HypervClusterController_ListByHypervSite", "description": "List HypervCluster resources by HypervSite", "parameters": [ { @@ -825,15 +823,15 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -867,10 +865,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}": { "get": { + "operationId": "HypervClusterController_GetCluster", "tags": [ "HypervClusterController" ], - "operationId": "HypervClusterController_GetCluster", "description": "Method to get a Hyper-V cluster.", "parameters": [ { @@ -885,16 +883,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "clusterName", "in": "path", - "required": true, "description": " Cluster ARM name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -923,10 +921,10 @@ } }, "put": { + "operationId": "HypervClusterController_CreateCluster", "tags": [ "HypervClusterController" ], - "operationId": "HypervClusterController_CreateCluster", "description": "Method to create or update a Hyper-V cluster.", "parameters": [ { @@ -941,24 +939,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "clusterName", "in": "path", - "required": true, "description": " Cluster ARM name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/HypervCluster" } @@ -973,15 +971,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCluster" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/HypervCluster" } }, "default": { @@ -1005,10 +1003,10 @@ } }, "delete": { + "operationId": "HypervClusterController_Delete", "tags": [ "HypervClusterController" ], - "operationId": "HypervClusterController_Delete", "description": "Delete a HypervCluster", "parameters": [ { @@ -1023,16 +1021,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "clusterName", "in": "path", - "required": true, "description": " Cluster ARM name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -1063,10 +1061,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/computeErrorSummary": { "post": { + "operationId": "HypervSitesController_ComputeErrorSummary", "tags": [ "HypervSitesController" ], - "operationId": "HypervSitesController_ComputeErrorSummary", "description": "Method to get site error summary.", "parameters": [ { @@ -1081,20 +1079,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -1124,10 +1120,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/computeusage": { "post": { + "operationId": "HypervSitesController_Computeusage", "tags": [ "HypervSitesController" ], - "operationId": "HypervSitesController_Computeusage", "description": "Get a hyperv site usage.", "parameters": [ { @@ -1142,20 +1138,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -1185,10 +1179,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportApplications": { "post": { + "operationId": "HypervSitesController_ExportApplications", "tags": [ "HypervSitesController" ], - "operationId": "HypervSitesController_ExportApplications", "description": "Method to generate report containing\r\n machine and the deep discovery of the application installed in the machine.", "parameters": [ { @@ -1203,20 +1197,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -1224,22 +1216,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1266,10 +1256,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportDependencies": { "post": { + "operationId": "HypervDependencyMapController_ExportDependencies", "tags": [ "HypervDependencyMapController" ], - "operationId": "HypervDependencyMapController_ExportDependencies", "description": "API to generate report containing agentless dependencies.", "parameters": [ { @@ -1284,16 +1274,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "requestBody", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsExportDependenciesRequest" } @@ -1303,22 +1293,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1345,10 +1333,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/exportMachineErrors": { "post": { + "operationId": "HypervSitesController_ExportMachineErrors", "tags": [ "HypervSitesController" ], - "operationId": "HypervSitesController_ExportMachineErrors", "description": "Method to generate report containing \r\n machine and the errors encountered during guest discovery of the machine.", "parameters": [ { @@ -1363,16 +1351,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/ExportMachineErrorsRequest" } @@ -1382,22 +1370,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1424,10 +1410,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/generateCoarseMap": { "post": { + "operationId": "HypervDependencyMapController_GenerateCoarseMap", "tags": [ "HypervDependencyMapController" ], - "operationId": "HypervDependencyMapController_GenerateCoarseMap", "description": "API to generate coarse map for the list of machines.", "parameters": [ { @@ -1442,16 +1428,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsScopeMapRequest" } @@ -1461,22 +1447,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1503,10 +1487,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/generateDetailedMap": { "post": { + "operationId": "HypervDependencyMapController_GenerateDetailedMap", "tags": [ "HypervDependencyMapController" ], - "operationId": "HypervDependencyMapController_GenerateDetailedMap", "description": "API to generate detailed map for a selected machine.", "parameters": [ { @@ -1521,16 +1505,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest" } @@ -1540,22 +1524,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1582,10 +1564,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts": { "get": { + "operationId": "HypervHostController_ListByHypervSite", "tags": [ "HypervHostController" ], - "operationId": "HypervHostController_ListByHypervSite", "description": "List HypervHost resources by HypervSite", "parameters": [ { @@ -1600,15 +1582,15 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -1642,10 +1624,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/hosts/{hostName}": { "get": { + "operationId": "HypervHostController_Get", "tags": [ "HypervHostController" ], - "operationId": "HypervHostController_Get", "description": "Get a HypervHost", "parameters": [ { @@ -1660,16 +1642,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "hostName", "in": "path", - "required": true, "description": " Host name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -1698,10 +1680,10 @@ } }, "put": { + "operationId": "HypervHostController_Create", "tags": [ "HypervHostController" ], - "operationId": "HypervHostController_Create", "description": "Create a HypervHost", "parameters": [ { @@ -1716,24 +1698,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "hostName", "in": "path", - "required": true, "description": " Host name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/HypervHost" } @@ -1748,15 +1730,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervHost" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/HypervHost" } }, "default": { @@ -1780,10 +1762,10 @@ } }, "delete": { + "operationId": "HypervHostController_Delete", "tags": [ "HypervHostController" ], - "operationId": "HypervHostController_Delete", "description": "Delete a HypervHost", "parameters": [ { @@ -1798,16 +1780,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "hostName", "in": "path", - "required": true, "description": " Host name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -1820,13 +1802,13 @@ "description": "Resource deletion accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -1856,10 +1838,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs": { "get": { + "operationId": "HypervJobs_ListByHypervSite", "tags": [ "HypervJobs" ], - "operationId": "HypervJobs_ListByHypervSite", "description": "List HypervJob resources by HypervSite", "parameters": [ { @@ -1874,8 +1856,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -1909,10 +1891,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/jobs/{jobName}": { "get": { + "operationId": "HypervJobs_Get", "tags": [ "HypervJobs" ], - "operationId": "HypervJobs_Get", "description": "Get a HypervJob", "parameters": [ { @@ -1927,16 +1909,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "jobName", "in": "path", - "required": true, "description": " Job name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -1967,10 +1949,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/listHealthSummary": { "post": { + "operationId": "HypervSitesController_ListHealthSummary", "tags": [ "HypervSitesController" ], - "operationId": "HypervSitesController_ListHealthSummary", "description": "Method to get site health summary.", "parameters": [ { @@ -1985,8 +1967,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -2017,10 +1999,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines": { "get": { + "operationId": "HypervMachinesController_ListByHypervSite", "tags": [ "HypervMachinesController" ], - "operationId": "HypervMachinesController_ListByHypervSite", "description": "List HypervMachine resources by HypervSite", "parameters": [ { @@ -2035,38 +2017,38 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "integer", "format": "int32" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -2100,10 +2082,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}": { "get": { + "operationId": "HypervMachinesController_Get", "tags": [ "HypervMachinesController" ], - "operationId": "HypervMachinesController_Get", "description": "Get a HypervMachine", "parameters": [ { @@ -2118,16 +2100,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": " HypervMachine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -2156,10 +2138,10 @@ } }, "patch": { + "operationId": "HypervMachinesController_Update", "tags": [ "HypervMachinesController" ], - "operationId": "HypervMachinesController_Update", "description": "Update a HypervMachine", "parameters": [ { @@ -2174,24 +2156,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": " HypervMachine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/HypervMachineUpdate" } @@ -2221,13 +2203,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareinventories": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { "get": { + "operationId": "HypervSoftwareInventoriesController_GetMachineSoftwareInventory", "tags": [ "HypervSoftwareInventoriesController" ], - "operationId": "HypervSoftwareInventoriesController_ListByHypervMachine", - "description": "List HypervVmSoftwareInventory resources by HypervMachine", + "description": "Method to get a machines software inventory like applications and roles.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -2241,25 +2223,46 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": " HypervMachine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "default", + "in": "path", + "description": "Default value.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "Default", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } } ], "responses": { "200": { "description": "ARM operation completed successfully.", "schema": { - "$ref": "#/definitions/HypervVmSoftwareInventoryListResult" + "$ref": "#/definitions/HypervVmSoftwareInventory" } }, "default": { @@ -2269,26 +2272,23 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen": { - "$ref": "./examples/HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen.json" + "HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen": { + "$ref": "./examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json" }, - "HypervSoftwareInventoriesController_ListByHypervMachine_MinimumSet_Gen": { - "$ref": "./examples/HypervSoftwareInventoriesController_ListByHypervMachine_MinimumSet_Gen.json" + "HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen": { + "$ref": "./examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/machines/{machineName}/softwareinventories": { "get": { + "operationId": "HypervSoftwareInventoriesController_ListByHypervMachine", "tags": [ "HypervSoftwareInventoriesController" ], - "operationId": "HypervSoftwareInventoriesController_GetMachineSoftwareInventory", - "description": "Method to get a machines software inventory like applications and roles.", + "description": "List HypervVmSoftwareInventory resources by HypervMachine", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -2302,47 +2302,26 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": " HypervMachine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "default", - "in": "path", - "required": true, - "description": "Default value.", - "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "Default", - "modelAsString": true, - "values": [ - { - "name": "default", - "value": "default", - "description": "default value." - } - ] - } - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/HypervVmSoftwareInventory" - } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervVmSoftwareInventoryListResult" + } }, "default": { "description": "An unexpected error response.", @@ -2351,22 +2330,25 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen": { - "$ref": "./examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json" + "HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen": { + "$ref": "./examples/HypervSoftwareInventoriesController_ListByHypervMachine_MaximumSet_Gen.json" }, - "HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen": { - "$ref": "./examples/HypervSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen.json" + "HypervSoftwareInventoriesController_ListByHypervMachine_MinimumSet_Gen": { + "$ref": "./examples/HypervSoftwareInventoriesController_ListByHypervMachine_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/operationsStatus/{operationStatusName}": { "get": { + "operationId": "HypervOperationsStatusController_GetHypervOperationsStatus", "tags": [ "HypervOperationsStatusController" ], - "operationId": "HypervOperationsStatusController_GetHypervOperationsStatus", "description": "Method to get operation status.", "parameters": [ { @@ -2381,16 +2363,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "operationStatusName", "in": "path", - "required": true, "description": "Operation status Arm Name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -2421,10 +2403,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/runAsAccounts": { "get": { + "operationId": "HypervRunAsAccountsController_ListByHypervSite", "tags": [ "HypervRunAsAccountsController" ], - "operationId": "HypervRunAsAccountsController_ListByHypervSite", "description": "List HypervRunAsAccountResource resources by HypervSite", "parameters": [ { @@ -2439,8 +2421,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -2474,10 +2456,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/runAsAccounts/{accountName}": { "get": { + "operationId": "HypervRunAsAccountsController_Get", "tags": [ "HypervRunAsAccountsController" ], - "operationId": "HypervRunAsAccountsController_Get", "description": "Get a HypervRunAsAccountResource", "parameters": [ { @@ -2492,16 +2474,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "accountName", "in": "path", - "required": true, "description": " RunAsAccounts name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -2532,10 +2514,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/serverGroupMembers": { "post": { + "operationId": "HypervDependencyMapController_ServerGroupMembers", "tags": [ "HypervDependencyMapController" ], - "operationId": "HypervDependencyMapController_ServerGroupMembers", "description": "API to list server group members for the selected server group.", "parameters": [ { @@ -2550,16 +2532,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsServerGroupMembersRequest" } @@ -2569,22 +2551,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -2611,10 +2591,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/summary": { "post": { + "operationId": "HypervSitesController_Summary", "tags": [ "HypervSitesController" ], - "operationId": "HypervSitesController_Summary", "description": "Method to get site usage.", "parameters": [ { @@ -2629,8 +2609,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -2661,10 +2641,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/updateDependencyMapStatus": { "post": { + "operationId": "HypervDependencyMapController_UpdateDependencyMapStatus", "tags": [ "HypervDependencyMapController" ], - "operationId": "HypervDependencyMapController_UpdateDependencyMapStatus", "description": "Method to enable disable dependency map status for machines\r\n in a site.", "parameters": [ { @@ -2679,16 +2659,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/UpdateMachineDepMapStatus" } @@ -2698,22 +2678,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -2740,10 +2718,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/updateProperties": { "post": { + "operationId": "HypervMachinesController_UpdateProperties", "tags": [ "HypervMachinesController" ], - "operationId": "HypervMachinesController_UpdateProperties", "description": "Method to update custom properties for HYPERV machines\r\n in a site.", "parameters": [ { @@ -2758,16 +2736,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "metaData", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/MachineMetadataCollection" } @@ -2777,22 +2755,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -2819,10 +2795,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites": { "get": { + "operationId": "ImportSitesController_ListByResourceGroup", "tags": [ "ImportSitesController" ], - "operationId": "ImportSitesController_ListByResourceGroup", "description": "Get all import sites.", "parameters": [ { @@ -2864,10 +2840,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}": { "get": { + "operationId": "ImportSitesController_Get", "tags": [ "ImportSitesController" ], - "operationId": "ImportSitesController_Get", "description": "Get a ImportSite", "parameters": [ { @@ -2882,8 +2858,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -2912,10 +2888,10 @@ } }, "put": { + "operationId": "ImportSitesController_Create", "tags": [ "ImportSitesController" ], - "operationId": "ImportSitesController_Create", "description": "Create a ImportSite", "parameters": [ { @@ -2930,16 +2906,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/ImportSite" } @@ -2954,15 +2930,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportSite" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/ImportSite" } }, "default": { @@ -2982,10 +2958,10 @@ } }, "patch": { + "operationId": "ImportSitesController_Update", "tags": [ "ImportSitesController" ], - "operationId": "ImportSitesController_Update", "description": "Update a ImportSite", "parameters": [ { @@ -3000,16 +2976,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/ImportSiteUpdate" } @@ -3039,10 +3015,10 @@ } }, "delete": { + "operationId": "ImportSitesController_Delete", "tags": [ "ImportSitesController" ], - "operationId": "ImportSitesController_Delete", "description": "Delete a ImportSite", "parameters": [ { @@ -3057,8 +3033,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3089,10 +3065,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteImportedMachines": { "post": { + "operationId": "ImportSitesController_DeleteImportedMachines", "tags": [ "ImportSitesController" ], - "operationId": "ImportSitesController_DeleteImportedMachines", "description": "Deletes the imported machines for site.", "parameters": [ { @@ -3107,20 +3083,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -3150,10 +3124,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs": { "get": { + "operationId": "ImportJobsController_ListDeletejobs", "tags": [ "ImportJobsController" ], - "operationId": "ImportJobsController_ListDeletejobs", "description": "Method to get all delete import machines job for the given site.", "parameters": [ { @@ -3168,8 +3142,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3203,10 +3177,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs/{jobName}": { "get": { + "operationId": "ImportJobsController_GetDeletejob", "tags": [ "ImportJobsController" ], - "operationId": "ImportJobsController_GetDeletejob", "description": "Gets the delete imported machines job with the given job name.", "parameters": [ { @@ -3221,16 +3195,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "jobName", "in": "path", - "required": true, "description": "Job Arm Name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3261,10 +3235,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs": { "get": { + "operationId": "ImportJobsController_ListExportjobs", "tags": [ "ImportJobsController" ], - "operationId": "ImportJobsController_ListExportjobs", "description": "Method to get all export import machines job for the given site.", "parameters": [ { @@ -3279,8 +3253,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3314,10 +3288,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs/{jobName}": { "get": { + "operationId": "ImportJobsController_GetExportjob", "tags": [ "ImportJobsController" ], - "operationId": "ImportJobsController_GetExportjob", "description": "Gets the export imported machines job with the given job name.", "parameters": [ { @@ -3332,16 +3306,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "jobName", "in": "path", - "required": true, "description": "Job Arm Name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3372,10 +3346,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportUri": { "post": { + "operationId": "ImportSitesController_ExportUri", "tags": [ "ImportSitesController" ], - "operationId": "ImportSitesController_ExportUri", "description": "Method to export a site.", "parameters": [ { @@ -3390,16 +3364,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/SasUriResponse" } @@ -3431,10 +3405,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs": { "get": { + "operationId": "ImportJobsController_ListImportjobs", "tags": [ "ImportJobsController" ], - "operationId": "ImportJobsController_ListImportjobs", "description": "Method to get all import machines job for the given site.", "parameters": [ { @@ -3449,8 +3423,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3484,10 +3458,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs/{jobName}": { "get": { + "operationId": "ImportJobsController_GetImportjob", "tags": [ "ImportJobsController" ], - "operationId": "ImportJobsController_GetImportjob", "description": "Gets the import job with the given job name.", "parameters": [ { @@ -3502,16 +3476,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "jobName", "in": "path", - "required": true, "description": "Job Arm Name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3542,10 +3516,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importUri": { "post": { + "operationId": "ImportSitesController_ImportUri", "tags": [ "ImportSitesController" ], - "operationId": "ImportSitesController_ImportUri", "description": "Method to import a site.", "parameters": [ { @@ -3560,16 +3534,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/SasUriResponse" } @@ -3601,10 +3575,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs": { "get": { + "operationId": "ImportJobsController_ListByImportSite", "tags": [ "ImportJobsController" ], - "operationId": "ImportJobsController_ListByImportSite", "description": "List ImportJob resources by ImportSite", "parameters": [ { @@ -3619,8 +3593,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3654,10 +3628,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs/{jobName}": { "get": { + "operationId": "ImportJobsController_Get", "tags": [ "ImportJobsController" ], - "operationId": "ImportJobsController_Get", "description": "Get a ImportJob", "parameters": [ { @@ -3672,16 +3646,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "jobName", "in": "path", - "required": true, "description": " Jobs name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3712,10 +3686,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines": { "get": { + "operationId": "ImportMachinesController_ListByImportSite", "tags": [ "ImportMachinesController" ], - "operationId": "ImportMachinesController_ListByImportSite", "description": "List ImportMachine resources by ImportSite", "parameters": [ { @@ -3730,37 +3704,37 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3794,10 +3768,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/machines/{machineName}": { "get": { + "operationId": "ImportMachinesController_Get", "tags": [ "ImportMachinesController" ], - "operationId": "ImportMachinesController_Get", "description": "Get a ImportMachine", "parameters": [ { @@ -3812,16 +3786,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": "Machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3850,10 +3824,10 @@ } }, "delete": { + "operationId": "ImportMachinesController_Delete", "tags": [ "ImportMachinesController" ], - "operationId": "ImportMachinesController_Delete", "description": "Delete a ImportMachine", "parameters": [ { @@ -3868,16 +3842,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": "Machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -3908,10 +3882,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites": { "get": { + "operationId": "MasterSitesController_ListByResourceGroup", "tags": [ "MasterSitesController" ], - "operationId": "MasterSitesController_ListByResourceGroup", "summary": "Get all sites.", "description": "Get all the sites in the resource group.", "parameters": [ @@ -3954,10 +3928,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}": { "get": { + "operationId": "MasterSitesController_Get", "tags": [ "MasterSitesController" ], - "operationId": "MasterSitesController_Get", "summary": "Method to get a master site.", "description": "Get a MasterSite", "parameters": [ @@ -3973,8 +3947,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -4003,10 +3977,10 @@ } }, "put": { + "operationId": "MasterSitesController_Create", "tags": [ "MasterSitesController" ], - "operationId": "MasterSitesController_Create", "description": "Method to create or update a site.", "parameters": [ { @@ -4021,16 +3995,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/MasterSite" } @@ -4045,15 +4019,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSite" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/MasterSite" } }, "default": { @@ -4076,12 +4050,12 @@ } } }, - "delete": { + "patch": { + "operationId": "MasterSitesController_Update", "tags": [ "MasterSitesController" ], - "operationId": "MasterSitesController_Delete", - "description": "Method to delete a site.", + "description": "Method to update an existing site.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -4095,18 +4069,41 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MasterSiteUpdate" + } } ], "responses": { "200": { - "description": "Resource deleted successfully." + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MasterSite" + } }, - "204": { - "description": "Resource deleted successfully." + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } }, "default": { "description": "An unexpected error response.", @@ -4115,21 +4112,25 @@ } } }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "MasterSitesController_Delete_MaximumSet_Gen": { - "$ref": "./examples/MasterSitesController_Delete_MaximumSet_Gen.json" + "MasterSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_Update_MaximumSet_Gen.json" }, - "MasterSitesController_Delete_MinimumSet_Gen": { - "$ref": "./examples/MasterSitesController_Delete_MinimumSet_Gen.json" + "MasterSitesController_Update_MinimumSet_Gen": { + "$ref": "./examples/MasterSitesController_Update_MinimumSet_Gen.json" } } }, - "patch": { + "delete": { + "operationId": "MasterSitesController_Delete", "tags": [ "MasterSitesController" ], - "operationId": "MasterSitesController_Update", - "description": "Method to update an existing site.", + "description": "Method to delete a site.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -4143,41 +4144,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "properties", - "in": "body", - "required": true, - "description": "The resource properties to be updated.", - "schema": { - "$ref": "#/definitions/MasterSiteUpdate" - } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/MasterSite" - } + "description": "Resource deleted successfully." }, - "202": { - "description": "Resource update request accepted.", - "headers": { - "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", - "type": "integer", - "format": "int32" - }, - "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" - } - } + "204": { + "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", @@ -4186,26 +4164,22 @@ } } }, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "MasterSitesController_Update_MaximumSet_Gen": { - "$ref": "./examples/MasterSitesController_Update_MaximumSet_Gen.json" + "MasterSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/MasterSitesController_Delete_MaximumSet_Gen.json" }, - "MasterSitesController_Update_MinimumSet_Gen": { - "$ref": "./examples/MasterSitesController_Update_MinimumSet_Gen.json" + "MasterSitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/MasterSitesController_Delete_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/errorSummary": { "post": { + "operationId": "MasterSitesController_ErrorSummary", "tags": [ "MasterSitesController" ], - "operationId": "MasterSitesController_ErrorSummary", "description": "Method to get error summary from master site for an appliance.", "parameters": [ { @@ -4220,16 +4194,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/ErrorSummaryRequest" } @@ -4261,10 +4235,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/operationsStatus/{operationStatusName}": { "get": { + "operationId": "MasterSitesOperationsStatusController_GetVmwareOperationStatus", "tags": [ "MasterSitesOperationsStatusController" ], - "operationId": "MasterSitesOperationsStatusController_GetVmwareOperationStatus", "description": "A operation status resource belonging to a master site resource.", "parameters": [ { @@ -4279,16 +4253,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "operationStatusName", "in": "path", - "required": true, "description": "Operation status Arm Name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -4319,10 +4293,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections": { "get": { + "operationId": "PrivateEndpointConnectionController_ListByMasterSite", "tags": [ "PrivateEndpointConnectionController" ], - "operationId": "PrivateEndpointConnectionController_ListByMasterSite", "description": "Gets the private link resource.", "parameters": [ { @@ -4337,8 +4311,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -4372,10 +4346,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateEndpointConnections/{peConnectionName}": { "get": { + "operationId": "PrivateEndpointConnectionController_Get", "tags": [ "PrivateEndpointConnectionController" ], - "operationId": "PrivateEndpointConnectionController_Get", "description": "Gets the private link resource.", "parameters": [ { @@ -4390,16 +4364,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "peConnectionName", "in": "path", - "required": true, "description": " Private link resource name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -4427,12 +4401,12 @@ } } }, - "delete": { + "put": { + "operationId": "PrivateEndpointConnectionController_Create", "tags": [ "PrivateEndpointConnectionController" ], - "operationId": "PrivateEndpointConnectionController_Delete", - "description": "Deletes the private link resource.", + "description": "Gets the private link resource.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -4446,26 +4420,48 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "peConnectionName", "in": "path", - "required": true, "description": " Private link resource name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } } ], "responses": { "200": { - "description": "Resource deleted successfully." + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } }, - "204": { - "description": "Resource deleted successfully." + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } }, "default": { "description": "An unexpected error response.", @@ -4475,20 +4471,20 @@ } }, "x-ms-examples": { - "PrivateEndpointConnectionController_Delete_MaximumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnectionController_Delete_MaximumSet_Gen.json" + "PrivateEndpointConnectionController_Create_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Create_MaximumSet_Gen.json" }, - "PrivateEndpointConnectionController_Delete_MinimumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnectionController_Delete_MinimumSet_Gen.json" + "PrivateEndpointConnectionController_Create_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Create_MinimumSet_Gen.json" } } }, - "put": { + "delete": { + "operationId": "PrivateEndpointConnectionController_Delete", "tags": [ "PrivateEndpointConnectionController" ], - "operationId": "PrivateEndpointConnectionController_Create", - "description": "Gets the private link resource.", + "description": "Deletes the private link resource.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -4502,48 +4498,26 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "peConnectionName", "in": "path", - "required": true, "description": " Private link resource name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "body", - "in": "body", - "required": true, - "description": "Resource create parameters.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } } ], "responses": { "200": { - "description": "ARM update operation completed successfully.", - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } + "description": "Resource deleted successfully." }, - "201": { - "description": "ARM create operation completed successfully.", - "headers": { - "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", - "type": "integer", - "format": "int32" - } - }, - "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" - } + "204": { + "description": "Resource deleted successfully." }, "default": { "description": "An unexpected error response.", @@ -4553,21 +4527,21 @@ } }, "x-ms-examples": { - "PrivateEndpointConnectionController_Create_MaximumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnectionController_Create_MaximumSet_Gen.json" + "PrivateEndpointConnectionController_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Delete_MaximumSet_Gen.json" }, - "PrivateEndpointConnectionController_Create_MinimumSet_Gen": { - "$ref": "./examples/PrivateEndpointConnectionController_Create_MinimumSet_Gen.json" + "PrivateEndpointConnectionController_Delete_MinimumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionController_Delete_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources": { "get": { + "operationId": "PrivateLinkResourcesController_ListByMasterSite", "tags": [ "PrivateLinkResourcesController" ], - "operationId": "PrivateLinkResourcesController_ListByMasterSite", "description": "Gets the private link resource.", "parameters": [ { @@ -4582,8 +4556,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -4617,10 +4591,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/privateLinkResources/{privateLinkResourceName}": { "get": { + "operationId": "PrivateLinkResourcesController_Get", "tags": [ "PrivateLinkResourcesController" ], - "operationId": "PrivateLinkResourcesController_Get", "description": "Gets the private link resource.", "parameters": [ { @@ -4635,16 +4609,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "privateLinkResourceName", "in": "path", - "required": true, "description": "Private link resource name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -4675,10 +4649,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites": { "get": { + "operationId": "SqlSitesController_ListByMasterSite", "tags": [ "SqlSitesController" ], - "operationId": "SqlSitesController_ListByMasterSite", "description": "Method to get all sites.", "parameters": [ { @@ -4693,8 +4667,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -4728,10 +4702,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}": { "get": { + "operationId": "SqlSitesController_Get", "tags": [ "SqlSitesController" ], - "operationId": "SqlSitesController_Get", "description": "Method to get a site.", "parameters": [ { @@ -4746,16 +4720,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -4783,67 +4757,11 @@ } } }, - "delete": { - "tags": [ - "SqlSitesController" - ], - "operationId": "SqlSitesController_Delete", - "description": "Deletes the SQL site.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "siteName", - "in": "path", - "required": true, - "description": "Site name", - "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "sqlSiteName", - "in": "path", - "required": true, - "description": "SQL site name.", - "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,24}$" - } - ], - "responses": { - "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SqlSitesController_Delete_MaximumSet_Gen": { - "$ref": "./examples/SqlSitesController_Delete_MaximumSet_Gen.json" - }, - "SqlSitesController_Delete_MinimumSet_Gen": { - "$ref": "./examples/SqlSitesController_Delete_MinimumSet_Gen.json" - } - } - }, "put": { + "operationId": "SqlSitesController_Create", "tags": [ "SqlSitesController" ], - "operationId": "SqlSitesController_Create", "description": "Method to create a SQL site.", "parameters": [ { @@ -4858,24 +4776,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/SqlSite" } @@ -4890,15 +4808,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlSite" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/SqlSite" } }, "default": { @@ -4918,10 +4836,10 @@ } }, "patch": { + "operationId": "SqlSitesController_Update", "tags": [ "SqlSitesController" ], - "operationId": "SqlSitesController_Update", "description": "Method to update an existing site.", "parameters": [ { @@ -4936,24 +4854,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "properties", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/SqlSiteUpdate" } @@ -4970,13 +4888,13 @@ "description": "Resource update request accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -4999,15 +4917,13 @@ "$ref": "./examples/SqlSitesController_Update_MinimumSet_Gen.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources": { - "get": { + }, + "delete": { + "operationId": "SqlSitesController_Delete", "tags": [ - "SqlDiscoverySiteDataSourceController" + "SqlSitesController" ], - "operationId": "SqlDiscoverySiteDataSourceController_ListBySqlSite", - "description": "List SqlDiscoverySiteDataSource resources by SqlSite", + "description": "Deletes the SQL site.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -5021,16 +4937,74 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", + "description": "SQL site name.", "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlSitesController_Delete_MaximumSet_Gen.json" + }, + "SqlSitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/SqlSitesController_Delete_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources": { + "get": { + "operationId": "SqlDiscoverySiteDataSourceController_ListBySqlSite", + "tags": [ + "SqlDiscoverySiteDataSourceController" + ], + "description": "List SqlDiscoverySiteDataSource resources by SqlSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "sqlSiteName", + "in": "path", "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -5064,10 +5038,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}": { "get": { + "operationId": "SqlDiscoverySiteDataSourceController_Get", "tags": [ "SqlDiscoverySiteDataSourceController" ], - "operationId": "SqlDiscoverySiteDataSourceController_Get", "description": "Get a SqlDiscoverySiteDataSource", "parameters": [ { @@ -5082,24 +5056,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "discoverySiteDataSourceName", "in": "path", - "required": true, "description": "SQL Discovery site data source name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -5128,10 +5102,10 @@ } }, "put": { + "operationId": "SqlDiscoverySiteDataSourceController_Create", "tags": [ "SqlDiscoverySiteDataSourceController" ], - "operationId": "SqlDiscoverySiteDataSourceController_Create", "description": "Create a SqlDiscoverySiteDataSource", "parameters": [ { @@ -5146,32 +5120,32 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "discoverySiteDataSourceName", "in": "path", - "required": true, "description": "SQL Discovery site data source name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/SqlDiscoverySiteDataSource" } @@ -5186,15 +5160,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDiscoverySiteDataSource" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/SqlDiscoverySiteDataSource" } }, "default": { @@ -5218,10 +5192,10 @@ } }, "delete": { + "operationId": "SqlDiscoverySiteDataSourceController_Delete", "tags": [ "SqlDiscoverySiteDataSourceController" ], - "operationId": "SqlDiscoverySiteDataSourceController_Delete", "description": "Delete a SqlDiscoverySiteDataSource", "parameters": [ { @@ -5236,24 +5210,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "discoverySiteDataSourceName", "in": "path", - "required": true, "description": "SQL Discovery site data source name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -5284,11 +5258,11 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/errorSummary": { "post": { + "operationId": "SqlSitesController_ErrorSummary", "tags": [ "SqlSitesController" ], - "operationId": "SqlSitesController_ErrorSummary", - "description": "MMethod to get error summary from SQL site.", + "description": "Method to get error summary from SQL site.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -5302,24 +5276,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/ErrorSummaryRequest" } @@ -5351,10 +5325,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/exportSqlServerErrors": { "post": { + "operationId": "SqlSitesController_ExportSqlServerErrors", "tags": [ "SqlSitesController" ], - "operationId": "SqlSitesController_ExportSqlServerErrors", "description": "Method to generate report containing SQL servers.", "parameters": [ { @@ -5369,28 +5343,26 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -5398,22 +5370,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -5440,10 +5410,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/exportSqlServers": { "post": { + "operationId": "SqlSitesController_ExportSqlServers", "tags": [ "SqlSitesController" ], - "operationId": "SqlSitesController_ExportSqlServers", "description": "Method to generate report containing SQL servers.", "parameters": [ { @@ -5458,24 +5428,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/ExportSqlServersRequest" } @@ -5485,22 +5455,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -5527,10 +5495,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/jobs": { "get": { + "operationId": "SqlJobsController_ListBySqlSite", "tags": [ "SqlJobsController" ], - "operationId": "SqlJobsController_ListBySqlSite", "summary": "Gets the sql Jobs.", "description": "List SqlJob resources by SqlSite", "parameters": [ @@ -5546,16 +5514,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -5589,10 +5557,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/jobs/{jobName}": { "get": { + "operationId": "SqlJobsController_Get", "tags": [ "SqlJobsController" ], - "operationId": "SqlJobsController_Get", "summary": "Gets the sql Job.", "description": "Get a SqlJob", "parameters": [ @@ -5608,24 +5576,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "jobName", "in": "path", - "required": true, "description": "SQL Job name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -5656,10 +5624,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/operationsStatus/{operationStatusName}": { "get": { + "operationId": "SqlOperationsStatusController_GetSqlOperationStatus", "tags": [ "SqlOperationsStatusController" ], - "operationId": "SqlOperationsStatusController_GetSqlOperationStatus", "description": "Method to get operation status.", "parameters": [ { @@ -5674,24 +5642,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "operationStatusName", "in": "path", - "required": true, "description": "Operation status Arm Name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -5722,10 +5690,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/refresh": { "post": { + "operationId": "SqlSitesController_Refresh", "tags": [ "SqlSitesController" ], - "operationId": "SqlSitesController_Refresh", "description": "Method to refresh a site.", "parameters": [ { @@ -5740,24 +5708,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/SqlSiteRefreshBody" } @@ -5767,22 +5735,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -5809,10 +5775,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/runAsAccounts": { "get": { + "operationId": "SqlRunAsAccountsController_ListBySqlSite", "tags": [ "SqlRunAsAccountsController" ], - "operationId": "SqlRunAsAccountsController_ListBySqlSite", "description": "List SqlRunAsAccount resources by SqlSite", "parameters": [ { @@ -5827,16 +5793,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -5870,10 +5836,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/runAsAccounts/{accountName}": { "get": { + "operationId": "SqlRunAsAccountsController_Get", "tags": [ "SqlRunAsAccountsController" ], - "operationId": "SqlRunAsAccountsController_Get", "description": "Get a SqlRunAsAccount", "parameters": [ { @@ -5888,24 +5854,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "accountName", "in": "path", - "required": true, "description": "SQL RunAsAccounts name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -5936,10 +5902,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups": { "get": { + "operationId": "SqlAvailabilityGroupsController_ListBySqlSite", "tags": [ "SqlAvailabilityGroupsController" ], - "operationId": "SqlAvailabilityGroupsController_ListBySqlSite", "description": "Gets the sql availability groups.", "parameters": [ { @@ -5954,45 +5920,45 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -6026,10 +5992,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlAvailabilityGroups/{sqlAvailabilityGroupName}": { "get": { + "operationId": "SqlAvailabilityGroupsController_Get", "tags": [ "SqlAvailabilityGroupsController" ], - "operationId": "SqlAvailabilityGroupsController_Get", "description": "Gets the sql availability group.", "parameters": [ { @@ -6044,24 +6010,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlAvailabilityGroupName", "in": "path", - "required": true, "description": "SQL availability group name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -6092,10 +6058,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases": { "get": { + "operationId": "SqlDatabasesController_ListBySqlSite", "tags": [ "SqlDatabasesController" ], - "operationId": "SqlDatabasesController_ListBySqlSite", "description": "Gets the sql Databases.", "parameters": [ { @@ -6110,45 +6076,45 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -6182,10 +6148,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlDatabases/{sqlDatabaseName}": { "get": { + "operationId": "SqlDatabasesController_Get", "tags": [ "SqlDatabasesController" ], - "operationId": "SqlDatabasesController_Get", "description": "Gets the sql Database.", "parameters": [ { @@ -6200,24 +6166,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlDatabaseName", "in": "path", - "required": true, "description": "SQL Database name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -6248,10 +6214,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers": { "get": { + "operationId": "SqlServersController_ListBySqlSite", "tags": [ "SqlServersController" ], - "operationId": "SqlServersController_ListBySqlSite", "description": "Gets the sql servers.", "parameters": [ { @@ -6266,45 +6232,45 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -6338,10 +6304,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/sqlServers/{sqlServerName}": { "get": { + "operationId": "SqlServersController_Get", "tags": [ "SqlServersController" ], - "operationId": "SqlServersController_Get", "description": "Gets the sql server.", "parameters": [ { @@ -6356,24 +6322,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlServerName", "in": "path", - "required": true, "description": "SQL server name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -6402,10 +6368,10 @@ } }, "patch": { + "operationId": "SqlServersController_Update", "tags": [ "SqlServersController" ], - "operationId": "SqlServersController_Update", "description": "Updates the sql server tags.", "parameters": [ { @@ -6420,32 +6386,32 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlServerName", "in": "path", - "required": true, "description": "SQL server name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/SqlServerV2Update" } @@ -6477,10 +6443,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/sqlSites/{sqlSiteName}/summary": { "post": { + "operationId": "SqlSitesController_Summary", "tags": [ "SqlSitesController" ], - "operationId": "SqlSitesController_Summary", "description": "Method to get site usage/summary.", "parameters": [ { @@ -6495,16 +6461,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "sqlSiteName", "in": "path", - "required": true, "description": "SQL site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -6535,10 +6501,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites": { "get": { + "operationId": "WebAppSitesController_ListByMasterSite", "tags": [ "WebAppSitesController" ], - "operationId": "WebAppSitesController_ListByMasterSite", "description": "Method to get all sites.", "parameters": [ { @@ -6553,8 +6519,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -6588,10 +6554,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}": { "get": { + "operationId": "WebAppSitesController_Get", "tags": [ "WebAppSitesController" ], - "operationId": "WebAppSitesController_Get", "description": "Method to get a site.", "parameters": [ { @@ -6606,16 +6572,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -6643,12 +6609,12 @@ } } }, - "delete": { + "put": { + "operationId": "WebAppSitesController_Create", "tags": [ "WebAppSitesController" ], - "operationId": "WebAppSitesController_Delete", - "description": "Deletes the WebApp site.", + "description": "Method to create a WebApp site.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -6662,41 +6628,49 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppSite" + } } ], "responses": { "200": { - "description": "Resource deleted successfully." + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSite" + } }, - "202": { - "description": "Resource deletion accepted.", + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppSite" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" - }, - "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, - "204": { - "description": "Resource deleted successfully." - }, "default": { "description": "An unexpected error response.", "schema": { @@ -6704,25 +6678,21 @@ } } }, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "WebAppSitesController_Delete_MaximumSet_Gen": { - "$ref": "./examples/WebAppSitesController_Delete_MaximumSet_Gen.json" + "WebAppSitesController_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Create_MaximumSet_Gen.json" }, - "WebAppSitesController_Delete_MinimumSet_Gen": { - "$ref": "./examples/WebAppSitesController_Delete_MinimumSet_Gen.json" + "WebAppSitesController_Create_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Create_MinimumSet_Gen.json" } } }, - "put": { + "patch": { + "operationId": "WebAppSitesController_Update", "tags": [ "WebAppSitesController" ], - "operationId": "WebAppSitesController_Create", - "description": "Method to create a WebApp site.", + "description": "Method to update an existing site.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -6736,47 +6706,48 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { - "name": "body", + "name": "properties", "in": "body", + "description": "The resource properties to be updated.", "required": true, - "description": "Resource create parameters.", "schema": { - "$ref": "#/definitions/WebAppSite" + "$ref": "#/definitions/WebAppSiteUpdate" } } ], "responses": { "200": { - "description": "ARM update operation completed successfully.", + "description": "ARM operation completed successfully.", "schema": { "$ref": "#/definitions/WebAppSite" } }, - "201": { - "description": "ARM create operation completed successfully.", + "202": { + "description": "Resource update request accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } - }, - "schema": { - "$ref": "#/definitions/WebAppSite" } }, "default": { @@ -6786,21 +6757,25 @@ } } }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "WebAppSitesController_Create_MaximumSet_Gen": { - "$ref": "./examples/WebAppSitesController_Create_MaximumSet_Gen.json" + "WebAppSitesController_Update_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Update_MaximumSet_Gen.json" }, - "WebAppSitesController_Create_MinimumSet_Gen": { - "$ref": "./examples/WebAppSitesController_Create_MinimumSet_Gen.json" + "WebAppSitesController_Update_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Update_MinimumSet_Gen.json" } } }, - "patch": { + "delete": { + "operationId": "WebAppSitesController_Delete", "tags": [ "WebAppSitesController" ], - "operationId": "WebAppSitesController_Update", - "description": "Method to update an existing site.", + "description": "Deletes the WebApp site.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -6814,50 +6789,41 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "properties", - "in": "body", - "required": true, - "description": "The resource properties to be updated.", - "schema": { - "$ref": "#/definitions/WebAppSiteUpdate" - } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/WebAppSite" - } + "description": "Resource deleted successfully." }, "202": { - "description": "Resource update request accepted.", + "description": "Resource deletion accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, + "204": { + "description": "Resource deleted successfully." + }, "default": { "description": "An unexpected error response.", "schema": { @@ -6870,21 +6836,21 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "WebAppSitesController_Update_MaximumSet_Gen": { - "$ref": "./examples/WebAppSitesController_Update_MaximumSet_Gen.json" + "WebAppSitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Delete_MaximumSet_Gen.json" }, - "WebAppSitesController_Update_MinimumSet_Gen": { - "$ref": "./examples/WebAppSitesController_Update_MinimumSet_Gen.json" + "WebAppSitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/WebAppSitesController_Delete_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources": { "get": { + "operationId": "WebAppDiscoverySiteDataSourcesController_ListByWebAppSite", "tags": [ "WebAppDiscoverySiteDataSourcesController" ], - "operationId": "WebAppDiscoverySiteDataSourcesController_ListByWebAppSite", "description": "Method to get all Web app data sources in site.", "parameters": [ { @@ -6899,16 +6865,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -6942,10 +6908,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/discoverySiteDataSources/{discoverySiteDataSourceName}": { "get": { + "operationId": "WebAppDiscoverySiteDataSourcesController_Get", "tags": [ "WebAppDiscoverySiteDataSourcesController" ], - "operationId": "WebAppDiscoverySiteDataSourcesController_Get", "description": "Method to get a Web app data source in site.", "parameters": [ { @@ -6960,24 +6926,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "discoverySiteDataSourceName", "in": "path", - "required": true, "description": "Data Source ARM name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -7005,12 +6971,12 @@ } } }, - "delete": { + "put": { + "operationId": "WebAppDiscoverySiteDataSourcesController_Create", "tags": [ "WebAppDiscoverySiteDataSourcesController" ], - "operationId": "WebAppDiscoverySiteDataSourcesController_Delete", - "description": "Method to delete a Web app data source in site.", + "description": "Method to create or update a Web app data source in site.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -7024,49 +6990,57 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "discoverySiteDataSourceName", "in": "path", - "required": true, "description": "Data Source ARM name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "body", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + } } ], "responses": { "200": { - "description": "Resource deleted successfully." + "description": "ARM update operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + } }, - "202": { - "description": "Resource deletion accepted.", + "201": { + "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscoverySiteDataSource" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" - }, - "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, - "204": { - "description": "Resource deleted successfully." - }, "default": { "description": "An unexpected error response.", "schema": { @@ -7079,20 +7053,20 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen": { - "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen.json" + "WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen.json" }, - "WebAppDiscoverySiteDataSourcesController_Delete_MinimumSet_Gen": { - "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Delete_MinimumSet_Gen.json" + "WebAppDiscoverySiteDataSourcesController_Create_MinimumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Create_MinimumSet_Gen.json" } } }, - "put": { + "delete": { + "operationId": "WebAppDiscoverySiteDataSourcesController_Delete", "tags": [ "WebAppDiscoverySiteDataSourcesController" ], - "operationId": "WebAppDiscoverySiteDataSourcesController_Create", - "description": "Method to create or update a Web app data source in site.", + "description": "Method to delete a Web app data source in site.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -7106,57 +7080,49 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "discoverySiteDataSourceName", "in": "path", - "required": true, "description": "Data Source ARM name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "body", - "in": "body", - "required": true, - "description": "Resource create parameters.", - "schema": { - "$ref": "#/definitions/DiscoverySiteDataSource" - } } ], "responses": { "200": { - "description": "ARM update operation completed successfully.", - "schema": { - "$ref": "#/definitions/DiscoverySiteDataSource" - } + "description": "Resource deleted successfully." }, - "201": { - "description": "ARM create operation completed successfully.", + "202": { + "description": "Resource deletion accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } - }, - "schema": { - "$ref": "#/definitions/DiscoverySiteDataSource" } }, + "204": { + "description": "Resource deleted successfully." + }, "default": { "description": "An unexpected error response.", "schema": { @@ -7169,21 +7135,21 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen": { - "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Create_MaximumSet_Gen.json" + "WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Delete_MaximumSet_Gen.json" }, - "WebAppDiscoverySiteDataSourcesController_Create_MinimumSet_Gen": { - "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Create_MinimumSet_Gen.json" + "WebAppDiscoverySiteDataSourcesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/WebAppDiscoverySiteDataSourcesController_Delete_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/errorSummary": { "post": { + "operationId": "WebAppSitesController_ErrorSummary", "tags": [ "WebAppSitesController" ], - "operationId": "WebAppSitesController_ErrorSummary", "description": "MMethod to get error summary from web app site.", "parameters": [ { @@ -7198,24 +7164,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/ErrorSummaryRequest" } @@ -7247,10 +7213,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/exportInventory": { "post": { + "operationId": "WebAppSitesController_ExportInventory", "tags": [ "WebAppSitesController" ], - "operationId": "WebAppSitesController_ExportInventory", "description": "Method to generate report containing web app inventory.", "parameters": [ { @@ -7265,24 +7231,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/ExportWebAppsRequest" } @@ -7292,22 +7258,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -7334,10 +7298,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/extendedMachines": { "get": { + "operationId": "WebAppExtendedMachinesController_ListByWebAppSite", "tags": [ "WebAppExtendedMachinesController" ], - "operationId": "WebAppExtendedMachinesController_ListByWebAppSite", "description": "Method to get all extended machines.", "parameters": [ { @@ -7352,45 +7316,45 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -7424,10 +7388,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/extendedMachines/{extendedMachineName}": { "get": { + "operationId": "WebAppExtendedMachinesController_Get", "tags": [ "WebAppExtendedMachinesController" ], - "operationId": "WebAppExtendedMachinesController_Get", "description": "Method to get a extended machine.", "parameters": [ { @@ -7442,24 +7406,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "extendedMachineName", "in": "path", - "required": true, "description": "Extended machine name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -7490,10 +7454,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications": { "get": { + "operationId": "IisWebApplicationsController_ListByWebAppSite", "tags": [ "IisWebApplicationsController" ], - "operationId": "IisWebApplicationsController_ListByWebAppSite", "description": "Method to get all IIS web application.", "parameters": [ { @@ -7508,45 +7472,45 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -7580,10 +7544,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebApplications/{webApplicationName}": { "get": { + "operationId": "IisWebApplicationsController_Get", "tags": [ "IisWebApplicationsController" ], - "operationId": "IisWebApplicationsController_Get", "description": "Method to get an IIS web application.", "parameters": [ { @@ -7598,24 +7562,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webApplicationName", "in": "path", - "required": true, "description": "Web application name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -7644,10 +7608,10 @@ } }, "patch": { + "operationId": "IisWebApplicationsController_Update", "tags": [ "IisWebApplicationsController" ], - "operationId": "IisWebApplicationsController_Update", "description": "Method to update tags on IIS web application.", "parameters": [ { @@ -7662,32 +7626,32 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webApplicationName", "in": "path", - "required": true, "description": "Web application name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/IisWebApplicationsUpdate" } @@ -7719,10 +7683,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebServers": { "get": { + "operationId": "IisWebServersController_ListByWebAppSite", "tags": [ "IisWebServersController" ], - "operationId": "IisWebServersController_ListByWebAppSite", "description": "Method to get all IIS web servers.", "parameters": [ { @@ -7737,45 +7701,45 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -7809,10 +7773,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/iisWebServers/{webServerName}": { "get": { + "operationId": "IisWebServersController_Get", "tags": [ "IisWebServersController" ], - "operationId": "IisWebServersController_Get", "description": "Method to get an IIS web server.", "parameters": [ { @@ -7827,24 +7791,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webServerName", "in": "path", - "required": true, "description": "Web server name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -7875,10 +7839,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/refresh": { "post": { + "operationId": "WebAppSitesController_Refresh", "tags": [ "WebAppSitesController" ], - "operationId": "WebAppSitesController_Refresh", "description": "Method to refresh a site.", "parameters": [ { @@ -7893,24 +7857,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/ProxySiteRefreshBody" } @@ -7920,22 +7884,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -7962,10 +7924,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/runasaccounts": { "get": { + "operationId": "WebAppRunAsAccountsController_ListByWebAppSite", "tags": [ "WebAppRunAsAccountsController" ], - "operationId": "WebAppRunAsAccountsController_ListByWebAppSite", "description": "Method to get all run as accounts.", "parameters": [ { @@ -7980,16 +7942,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -8023,10 +7985,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/runasaccounts/{accountName}": { "get": { + "operationId": "WebAppRunAsAccountsController_Get", "tags": [ "WebAppRunAsAccountsController" ], - "operationId": "WebAppRunAsAccountsController_Get", "description": "Method to get run as account.", "parameters": [ { @@ -8041,24 +8003,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "accountName", "in": "path", - "required": true, "description": "Run as account ARM name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -8089,10 +8051,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/summary": { "post": { + "operationId": "WebAppSitesController_Summary", "tags": [ "WebAppSitesController" ], - "operationId": "WebAppSitesController_Summary", "description": "Method to get site usage/summary.", "parameters": [ { @@ -8107,16 +8069,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -8147,10 +8109,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications": { "get": { + "operationId": "TomcatWebApplicationsController_ListByWebAppSite", "tags": [ "TomcatWebApplicationsController" ], - "operationId": "TomcatWebApplicationsController_ListByWebAppSite", "description": "Method to get all Tomcat web application.", "parameters": [ { @@ -8165,45 +8127,45 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -8237,10 +8199,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebApplications/{webApplicationName}": { "get": { + "operationId": "TomcatWebApplicationsController_Get", "tags": [ "TomcatWebApplicationsController" ], - "operationId": "TomcatWebApplicationsController_Get", "description": "Method to get an Tomcat web application.", "parameters": [ { @@ -8255,24 +8217,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webApplicationName", "in": "path", - "required": true, "description": "Web application name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -8301,10 +8263,10 @@ } }, "patch": { + "operationId": "TomcatWebApplicationsController_Update", "tags": [ "TomcatWebApplicationsController" ], - "operationId": "TomcatWebApplicationsController_Update", "description": "Updates the Tomcat web application tags.", "parameters": [ { @@ -8319,32 +8281,32 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webApplicationName", "in": "path", - "required": true, "description": "Web application name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/TomcatWebApplicationsUpdate" } @@ -8376,10 +8338,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers": { "get": { + "operationId": "TomcatWebServersController_ListByWebAppSite", "tags": [ "TomcatWebServersController" ], - "operationId": "TomcatWebServersController_ListByWebAppSite", "description": "Method to get all Tomcat web servers.", "parameters": [ { @@ -8394,45 +8356,45 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -8466,10 +8428,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/tomcatWebServers/{webServerName}": { "get": { + "operationId": "TomcatWebServersController_Get", "tags": [ "TomcatWebServersController" ], - "operationId": "TomcatWebServersController_Get", "description": "Method to get an Tomcat web server.", "parameters": [ { @@ -8484,24 +8446,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webServerName", "in": "path", - "required": true, "description": "Web server name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -8532,10 +8494,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/updateProperties": { "post": { + "operationId": "WebAppPropertiesController_UpdateProperties", "tags": [ "WebAppPropertiesController" ], - "operationId": "WebAppPropertiesController_UpdateProperties", "description": "Method to update properties for web applications.\n in a site.", "parameters": [ { @@ -8550,24 +8512,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/WebAppPropertiesCollection" } @@ -8577,22 +8539,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -8619,10 +8579,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webApplications": { "get": { + "operationId": "WebApplicationsController_ListByWebAppSite", "tags": [ "WebApplicationsController" ], - "operationId": "WebApplicationsController_ListByWebAppSite", "description": "Method to get all IIS web applications.", "parameters": [ { @@ -8637,45 +8597,45 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -8709,10 +8669,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/masterSites/{siteName}/webAppSites/{webAppSiteName}/webServers": { "get": { + "operationId": "WebServersController_ListByWebAppSite", "tags": [ "WebServersController" ], - "operationId": "WebServersController_ListByWebAppSite", "description": "Method to get all web servers.", "parameters": [ { @@ -8727,45 +8687,45 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "webAppSiteName", "in": "path", - "required": true, "description": "Web app site name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -8799,10 +8759,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites": { "get": { + "operationId": "ServerSitesController_ListByResourceGroup", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_ListByResourceGroup", "description": "List ServerSiteResource resources by resource group", "parameters": [ { @@ -8844,10 +8804,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}": { "get": { + "operationId": "ServerSitesController_Get", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_Get", "description": "Get a ServerSiteResource", "parameters": [ { @@ -8862,8 +8822,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -8892,10 +8852,10 @@ } }, "put": { + "operationId": "ServerSitesController_Create", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_Create", "description": "Create a ServerSiteResource", "parameters": [ { @@ -8910,16 +8870,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/ServerSiteResource" } @@ -8934,15 +8894,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerSiteResource" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/ServerSiteResource" } }, "default": { @@ -8966,10 +8926,10 @@ } }, "patch": { + "operationId": "ServerSitesController_Update", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_Update", "description": "Update a ServerSiteResource", "parameters": [ { @@ -8984,16 +8944,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/ServerSiteResourceUpdate" } @@ -9023,10 +8983,10 @@ } }, "delete": { + "operationId": "ServerSitesController_Delete", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_Delete", "description": "Delete a ServerSiteResource", "parameters": [ { @@ -9041,8 +9001,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -9073,10 +9033,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/clientGroupMembers": { "post": { + "operationId": "ServerDependencyMapController_ClientGroupMembers", "tags": [ "ServerDependencyMapController" ], - "operationId": "ServerDependencyMapController_ClientGroupMembers", "description": "API to list client group members for the selected client group.", "parameters": [ { @@ -9091,16 +9051,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsClientGroupMembersRequest" } @@ -9110,22 +9070,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -9152,10 +9110,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/computeErrorSummary": { "post": { + "operationId": "ServerSitesController_ComputeErrorSummary", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_ComputeErrorSummary", "description": "Get the error summary for a server site.", "parameters": [ { @@ -9170,20 +9128,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -9213,10 +9169,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/computeusage": { "post": { + "operationId": "ServerSitesController_Computeusage", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_Computeusage", "description": "Get a serve site usage.", "parameters": [ { @@ -9231,20 +9187,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -9274,10 +9228,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/exportApplications": { "post": { + "operationId": "ServerSitesController_ExportApplications", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_ExportApplications", "description": "Method to generate report containing\r\n machine and the deep discovery of the application installed in the machine.", "parameters": [ { @@ -9292,20 +9246,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -9313,22 +9265,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -9355,10 +9305,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/exportDependencies": { "post": { + "operationId": "ServerDependencyMapController_ExportDependencies", "tags": [ "ServerDependencyMapController" ], - "operationId": "ServerDependencyMapController_ExportDependencies", "description": "API to generate report containing agentless dependencies.", "parameters": [ { @@ -9373,16 +9323,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "requestBody", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsExportDependenciesRequest" } @@ -9392,22 +9342,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -9434,10 +9382,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/exportMachineErrors": { "post": { + "operationId": "ServerSitesController_ExportMachineErrors", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_ExportMachineErrors", "description": "Method to generate report containing \r\n machine and the errors encountered during guest discovery of the machine.", "parameters": [ { @@ -9452,16 +9400,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/ExportMachineErrorsRequest" } @@ -9471,22 +9419,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -9513,10 +9459,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/generateCoarseMap": { "post": { + "operationId": "ServerDependencyMapController_GenerateCoarseMap", "tags": [ "ServerDependencyMapController" ], - "operationId": "ServerDependencyMapController_GenerateCoarseMap", "description": "API to generate coarse map for the list of machines.", "parameters": [ { @@ -9531,16 +9477,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsScopeMapRequest" } @@ -9550,22 +9496,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -9592,10 +9536,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/generateDetailedMap": { "post": { + "operationId": "ServerDependencyMapController_GenerateDetailedMap", "tags": [ "ServerDependencyMapController" ], - "operationId": "ServerDependencyMapController_GenerateDetailedMap", "description": "API to generate detailed map for a selected machine.", "parameters": [ { @@ -9610,16 +9554,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest" } @@ -9629,22 +9573,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -9671,10 +9613,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/jobs": { "get": { + "operationId": "ServerJobsController_ListByServerSiteResource", "tags": [ "ServerJobsController" ], - "operationId": "ServerJobsController_ListByServerSiteResource", "description": "List ServerJob resources by ServerSiteResource", "parameters": [ { @@ -9689,8 +9631,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -9724,10 +9666,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/jobs/{jobName}": { "get": { + "operationId": "ServerJobsController_Get", "tags": [ "ServerJobsController" ], - "operationId": "ServerJobsController_Get", "description": "Get a ServerJob", "parameters": [ { @@ -9742,16 +9684,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "jobName", "in": "path", - "required": true, "description": " Jobs name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -9782,10 +9724,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/listHealthSummary": { "post": { + "operationId": "ServerSitesController_ListHealthSummary", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_ListHealthSummary", "description": "Method to get site health summary.", "parameters": [ { @@ -9800,8 +9742,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -9832,10 +9774,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines": { "get": { + "operationId": "ServersController_ListByServerSiteResource", "tags": [ "ServersController" ], - "operationId": "ServersController_ListByServerSiteResource", "description": "Get all machines in a site.", "parameters": [ { @@ -9850,37 +9792,37 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "string" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -9914,10 +9856,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}": { "get": { + "operationId": "ServersController_GetMachine", "tags": [ "ServersController" ], - "operationId": "ServersController_GetMachine", "description": "Get a Server", "parameters": [ { @@ -9932,16 +9874,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": " A server machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -9970,10 +9912,10 @@ } }, "patch": { + "operationId": "ServersController_UpdateMachine", "tags": [ "ServersController" ], - "operationId": "ServersController_UpdateMachine", "description": "Update a Server machine", "parameters": [ { @@ -9988,24 +9930,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": " A server machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/ServerUpdate" } @@ -10035,10 +9977,10 @@ } }, "delete": { + "operationId": "ServersController_DeleteMachine", "tags": [ "ServersController" ], - "operationId": "ServersController_DeleteMachine", "description": "Delete a Server", "parameters": [ { @@ -10053,16 +9995,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": " A server machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -10091,13 +10033,13 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareinventories": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { "get": { + "operationId": "ServerSoftwareInventoriesController_GetMachineSoftwareInventory", "tags": [ "ServerSoftwareInventoriesController" ], - "operationId": "ServerSoftwareInventoriesController_ListByServer", - "description": "List ServerSoftwareInventory resources by Server", + "description": "Method to get a machines software inventory like applications and roles.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -10111,25 +10053,46 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": " A server machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "default", + "in": "path", + "description": "Default value.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "Default", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default", + "description": "default value." + } + ] + } } ], "responses": { "200": { "description": "ARM operation completed successfully.", "schema": { - "$ref": "#/definitions/ServerSoftwareInventoryListResult" + "$ref": "#/definitions/ServerSoftwareInventory" } }, "default": { @@ -10139,26 +10102,23 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen": { - "$ref": "./examples/ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen.json" + "ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen": { + "$ref": "./examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json" }, - "ServerSoftwareInventoriesController_ListByServer_MinimumSet_Gen": { - "$ref": "./examples/ServerSoftwareInventoriesController_ListByServer_MinimumSet_Gen.json" + "ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen": { + "$ref": "./examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/machines/{machineName}/softwareinventories": { "get": { + "operationId": "ServerSoftwareInventoriesController_ListByServer", "tags": [ "ServerSoftwareInventoriesController" ], - "operationId": "ServerSoftwareInventoriesController_GetMachineSoftwareInventory", - "description": "Method to get a machines software inventory like applications and roles.", + "description": "List ServerSoftwareInventory resources by Server", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -10172,46 +10132,25 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": " A server machine name", - "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "default", - "in": "path", "required": true, - "description": "Default value.", "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "Default", - "modelAsString": true, - "values": [ - { - "name": "default", - "value": "default", - "description": "default value." - } - ] - } + "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { "description": "ARM operation completed successfully.", "schema": { - "$ref": "#/definitions/ServerSoftwareInventory" + "$ref": "#/definitions/ServerSoftwareInventoryListResult" } }, "default": { @@ -10221,22 +10160,25 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen": { - "$ref": "./examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json" + "ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen": { + "$ref": "./examples/ServerSoftwareInventoriesController_ListByServer_MaximumSet_Gen.json" }, - "ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen": { - "$ref": "./examples/ServerSoftwareInventoriesController_GetMachineSoftwareInventory_MinimumSet_Gen.json" + "ServerSoftwareInventoriesController_ListByServer_MinimumSet_Gen": { + "$ref": "./examples/ServerSoftwareInventoriesController_ListByServer_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/operationsStatus/{operationStatusName}": { "get": { + "operationId": "ServerOperationsStatusController_GetServerSiteOperationsStatus", "tags": [ "ServerOperationsStatusController" ], - "operationId": "ServerOperationsStatusController_GetServerSiteOperationsStatus", "description": "A operation status resource belonging to a site resource.", "parameters": [ { @@ -10251,16 +10193,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "operationStatusName", "in": "path", - "required": true, "description": "Operation status Arm Name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -10291,10 +10233,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/refreshSite": { "post": { + "operationId": "ServerSitesController_RefreshSite", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_RefreshSite", "description": "Operation to refresh a site", "parameters": [ { @@ -10309,8 +10251,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -10319,22 +10261,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -10361,10 +10301,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/runAsAccounts": { "get": { + "operationId": "ServerRunAsAccountsController_ListByServerSiteResource", "tags": [ "ServerRunAsAccountsController" ], - "operationId": "ServerRunAsAccountsController_ListByServerSiteResource", "description": "List ServerRunAsAccount resources by ServerSiteResource", "parameters": [ { @@ -10379,8 +10319,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -10414,10 +10354,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/runAsAccounts/{accountName}": { "get": { + "operationId": "ServerRunAsAccountsController_Get", "tags": [ "ServerRunAsAccountsController" ], - "operationId": "ServerRunAsAccountsController_Get", "description": "Get a ServerRunAsAccount", "parameters": [ { @@ -10432,16 +10372,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "accountName", "in": "path", - "required": true, "description": " RunAsAccounts name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -10472,10 +10412,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/serverGroupMembers": { "post": { + "operationId": "ServerDependencyMapController_ServerGroupMembers", "tags": [ "ServerDependencyMapController" ], - "operationId": "ServerDependencyMapController_ServerGroupMembers", "description": "API to list server group members for the selected server group.", "parameters": [ { @@ -10490,16 +10430,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsServerGroupMembersRequest" } @@ -10509,22 +10449,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -10551,10 +10489,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/summary": { "post": { + "operationId": "ServerSitesController_Summary", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_Summary", "description": "Method to get site usage.", "parameters": [ { @@ -10569,8 +10507,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -10601,10 +10539,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/updateDependencyMapStatus": { "post": { + "operationId": "ServerSitesController_UpdateDependencyMapStatus", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_UpdateDependencyMapStatus", "description": "Method to enable disable dependency map status for machines\r\n in a site.", "parameters": [ { @@ -10619,16 +10557,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/UpdateMachineDepMapStatus" } @@ -10638,22 +10576,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -10680,10 +10616,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/serverSites/{siteName}/updateProperties": { "post": { + "operationId": "ServerSitesController_UpdateProperties", "tags": [ "ServerSitesController" ], - "operationId": "ServerSitesController_UpdateProperties", "description": "Operation to update custom properties for servers", "parameters": [ { @@ -10698,16 +10634,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "metaData", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/MachineMetadataCollection" } @@ -10717,22 +10653,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -10759,10 +10693,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites": { "get": { + "operationId": "SitesController_ListByResourceGroup", "tags": [ "SitesController" ], - "operationId": "SitesController_ListByResourceGroup", "summary": "Get all vmware sites.", "description": "Get all the vmware sites in the resource group.", "parameters": [ @@ -10802,62 +10736,14 @@ } } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}": { - "get": { - "tags": [ - "SitesController" - ], - "operationId": "SitesController_Get", - "description": "Get a VmwareSite", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "siteName", - "in": "path", - "required": true, - "description": "Site name", - "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,24}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/VmwareSite" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "SitesController_Get_MaximumSet_Gen": { - "$ref": "./examples/SitesController_Get_MaximumSet_Gen.json" - }, - "SitesController_Get_MinimumSet_Gen": { - "$ref": "./examples/SitesController_Get_MinimumSet_Gen.json" - } - } - }, - "delete": { + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}": { + "get": { + "operationId": "SitesController_Get", "tags": [ "SitesController" ], - "operationId": "SitesController_Delete", - "description": "Delete a VmwareSite", + "description": "Get a VmwareSite", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -10871,18 +10757,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } ], "responses": { "200": { - "description": "Resource deleted successfully." - }, - "204": { - "description": "Resource deleted successfully." + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSite" + } }, "default": { "description": "An unexpected error response.", @@ -10892,19 +10778,19 @@ } }, "x-ms-examples": { - "SitesController_Delete_MaximumSet_Gen": { - "$ref": "./examples/SitesController_Delete_MaximumSet_Gen.json" + "SitesController_Get_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Get_MaximumSet_Gen.json" }, - "SitesController_Delete_MinimumSet_Gen": { - "$ref": "./examples/SitesController_Delete_MinimumSet_Gen.json" + "SitesController_Get_MinimumSet_Gen": { + "$ref": "./examples/SitesController_Get_MinimumSet_Gen.json" } } }, "put": { + "operationId": "SitesController_Create", "tags": [ "SitesController" ], - "operationId": "SitesController_Create", "description": "Create a VmwareSite", "parameters": [ { @@ -10919,16 +10805,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/VmwareSite" } @@ -10943,15 +10829,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareSite" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/VmwareSite" } }, "default": { @@ -10971,10 +10857,10 @@ } }, "patch": { + "operationId": "SitesController_Update", "tags": [ "SitesController" ], - "operationId": "SitesController_Update", "description": "Update a VmwareSite", "parameters": [ { @@ -10989,16 +10875,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/VmwareSiteUpdate" } @@ -11026,14 +10912,62 @@ "$ref": "./examples/SitesController_Update_MinimumSet_Gen.json" } } + }, + "delete": { + "operationId": "SitesController_Delete", + "tags": [ + "SitesController" + ], + "description": "Delete a VmwareSite", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SitesController_Delete_MaximumSet_Gen": { + "$ref": "./examples/SitesController_Delete_MaximumSet_Gen.json" + }, + "SitesController_Delete_MinimumSet_Gen": { + "$ref": "./examples/SitesController_Delete_MinimumSet_Gen.json" + } + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/clientGroupMembers": { "post": { + "operationId": "DependencyMapController_ClientGroupMembers", "tags": [ "DependencyMapController" ], - "operationId": "DependencyMapController_ClientGroupMembers", "description": "API to list client group members for the selected client group.", "parameters": [ { @@ -11048,16 +10982,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsClientGroupMembersRequest" } @@ -11067,22 +11001,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -11109,10 +11041,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/computeErrorSummary": { "post": { + "operationId": "SitesController_ComputeErrorSummary", "tags": [ "SitesController" ], - "operationId": "SitesController_ComputeErrorSummary", "description": "Method to get site error summary.", "parameters": [ { @@ -11127,20 +11059,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -11170,10 +11100,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/computeusage": { "post": { + "operationId": "SitesController_Computeusage", "tags": [ "SitesController" ], - "operationId": "SitesController_Computeusage", "description": "Method to get site error summary.", "parameters": [ { @@ -11188,20 +11118,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -11231,10 +11159,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportApplications": { "post": { + "operationId": "SitesController_ExportApplications", "tags": [ "SitesController" ], - "operationId": "SitesController_ExportApplications", "description": "Method to generate report containing\r\n machine and the deep discovery of the application installed in the machine.", "parameters": [ { @@ -11249,20 +11177,18 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } } ], @@ -11270,22 +11196,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -11312,10 +11236,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportDependencies": { "post": { + "operationId": "DependencyMapController_ExportDependencies", "tags": [ "DependencyMapController" ], - "operationId": "DependencyMapController_ExportDependencies", "description": "API to generate report containing agentless dependencies.", "parameters": [ { @@ -11330,16 +11254,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "requestBody", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsExportDependenciesRequest" } @@ -11349,22 +11273,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -11391,10 +11313,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportMachineErrors": { "post": { + "operationId": "SitesController_ExportMachineErrors", "tags": [ "SitesController" ], - "operationId": "SitesController_ExportMachineErrors", "description": "Method to generate report containing \r\n machine and the errors encountered during guest discovery of the machine.", "parameters": [ { @@ -11409,16 +11331,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/ExportMachineErrorsRequest" } @@ -11428,22 +11350,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -11470,10 +11390,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/exportMachines": { "post": { + "operationId": "SitesController_ExportMachines", "tags": [ "SitesController" ], - "operationId": "SitesController_ExportMachines", "description": "Method to generate report containing \r\n machine and the deep discovery of the application installed in the machine.", "parameters": [ { @@ -11488,16 +11408,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/ExportMachinesRequest" } @@ -11507,22 +11427,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -11549,10 +11467,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/generateCoarseMap": { "post": { + "operationId": "DependencyMapController_GenerateCoarseMap", "tags": [ "DependencyMapController" ], - "operationId": "DependencyMapController_GenerateCoarseMap", "description": "API to generate coarse map for the list of machines.", "parameters": [ { @@ -11567,16 +11485,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsScopeMapRequest" } @@ -11586,22 +11504,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -11628,10 +11544,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/generateDetailedMap": { "post": { + "operationId": "DependencyMapController_GenerateDetailedMap", "tags": [ "DependencyMapController" ], - "operationId": "DependencyMapController_GenerateDetailedMap", "description": "API to generate detailed map for a selected machine.", "parameters": [ { @@ -11646,16 +11562,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest" } @@ -11665,22 +11581,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -11707,10 +11621,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts": { "get": { + "operationId": "VmwareHostController_ListByVmwareSite", "tags": [ "VmwareHostController" ], - "operationId": "VmwareHostController_ListByVmwareSite", "description": "List VmwareHost resources by VmwareSite", "parameters": [ { @@ -11725,8 +11639,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -11760,10 +11674,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts/{hostName}": { "get": { + "operationId": "VmwareHostController_Get", "tags": [ "VmwareHostController" ], - "operationId": "VmwareHostController_Get", "description": "Get a VmwareHost", "parameters": [ { @@ -11778,16 +11692,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "hostName", "in": "path", - "required": true, "description": " Hosts name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -11818,10 +11732,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/jobs": { "get": { + "operationId": "HypervJobsController_ListByVmwareSite", "tags": [ "HypervJobsController" ], - "operationId": "HypervJobsController_ListByVmwareSite", "description": "List VmwareJob resources by VmwareSite", "parameters": [ { @@ -11836,8 +11750,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -11871,10 +11785,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/jobs/{jobName}": { "get": { + "operationId": "HypervJobsController_Get", "tags": [ "HypervJobsController" ], - "operationId": "HypervJobsController_Get", "description": "Get a VmwareJob", "parameters": [ { @@ -11889,16 +11803,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "jobName", "in": "path", - "required": true, "description": " Jobs name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -11929,10 +11843,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/listHealthSummary": { "post": { + "operationId": "SitesController_ListHealthSummary", "tags": [ "SitesController" ], - "operationId": "SitesController_ListHealthSummary", "description": "Method to get site health summary.", "parameters": [ { @@ -11947,8 +11861,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -11979,10 +11893,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines": { "get": { + "operationId": "MachinesController_ListByVmwareSite", "tags": [ "MachinesController" ], - "operationId": "MachinesController_ListByVmwareSite", "description": "List MachineResource resources by VmwareSite", "parameters": [ { @@ -11997,38 +11911,38 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "top", "in": "query", - "required": false, "description": "page size query", + "required": false, "type": "integer", "format": "int32" }, { "name": "continuationToken", "in": "query", - "required": false, "description": "Optional parameter for continuation token.", + "required": false, "type": "string" }, { "name": "totalRecordCount", "in": "query", - "required": false, "description": "Total count of machines in the given site.", + "required": false, "type": "integer", "format": "int32" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -12062,10 +11976,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}": { "get": { + "operationId": "MachinesController_Get", "tags": [ "MachinesController" ], - "operationId": "MachinesController_Get", "description": "Get a MachineResource", "parameters": [ { @@ -12080,16 +11994,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": "Machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -12118,10 +12032,10 @@ } }, "patch": { + "operationId": "MachinesController_Update", "tags": [ "MachinesController" ], - "operationId": "MachinesController_Update", "description": "Update a MachineResource", "parameters": [ { @@ -12136,24 +12050,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": "Machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/MachineResourceUpdate" } @@ -12177,79 +12091,18 @@ "MachinesController_Update_MaximumSet_Gen": { "$ref": "./examples/MachinesController_Update_MaximumSet_Gen.json" }, - "MachinesController_Update_MinimumSet_Gen": { - "$ref": "./examples/MachinesController_Update_MinimumSet_Gen.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareinventories": { - "get": { - "tags": [ - "VmwareSoftwareInventoriesController" - ], - "operationId": "VmwareSoftwareInventoriesController_ListByMachineResource", - "description": "List VmwareMachineSoftwareInventory resources by MachineResource", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "siteName", - "in": "path", - "required": true, - "description": "Site name", - "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,24}$" - }, - { - "name": "machineName", - "in": "path", - "required": true, - "description": "Machine name", - "type": "string", - "pattern": "^[a-zA-Z0-9-]{3,24}$" - } - ], - "responses": { - "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/VmwareMachineSoftwareInventoryListResult" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen": { - "$ref": "./examples/VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen.json" - }, - "VmwareSoftwareInventoriesController_ListByMachineResource_MinimumSet_Gen": { - "$ref": "./examples/VmwareSoftwareInventoriesController_ListByMachineResource_MinimumSet_Gen.json" + "MachinesController_Update_MinimumSet_Gen": { + "$ref": "./examples/MachinesController_Update_MinimumSet_Gen.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareInventories/{default}": { "get": { + "operationId": "VmwareSoftwareInventoriesController_GetMachineSoftwareInventory", "tags": [ "VmwareSoftwareInventoriesController" ], - "operationId": "VmwareSoftwareInventoriesController_GetMachineSoftwareInventory", "description": "Method to get a machines software inventory like applications and roles.", "parameters": [ { @@ -12264,24 +12117,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": "Machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "default", "in": "path", - "required": true, "description": "Default value.", + "required": true, "type": "string", "enum": [ "default" @@ -12323,12 +12176,73 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareinventories": { + "get": { + "operationId": "VmwareSoftwareInventoriesController_ListByMachineResource", + "tags": [ + "VmwareSoftwareInventoriesController" + ], + "description": "List VmwareMachineSoftwareInventory resources by MachineResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Machine name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareMachineSoftwareInventoryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen": { + "$ref": "./examples/VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen.json" + }, + "VmwareSoftwareInventoriesController_ListByMachineResource_MinimumSet_Gen": { + "$ref": "./examples/VmwareSoftwareInventoriesController_ListByMachineResource_MinimumSet_Gen.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/start": { "post": { + "operationId": "MachinesController_Start", "tags": [ "MachinesController" ], - "operationId": "MachinesController_Start", "description": "Method to start a machine.", "parameters": [ { @@ -12343,16 +12257,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": "Machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -12361,22 +12275,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -12403,10 +12315,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/stop": { "post": { + "operationId": "MachinesController_Stop", "tags": [ "MachinesController" ], - "operationId": "MachinesController_Stop", "description": "Method to stop a machine.", "parameters": [ { @@ -12421,16 +12333,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "machineName", "in": "path", - "required": true, "description": "Machine name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -12439,22 +12351,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -12481,10 +12391,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/operationsStatus/{operationStatusName}": { "get": { + "operationId": "VmwareOperationsStatus_GetVmwareOperationStatus", "tags": [ "VmwareOperationsStatus" ], - "operationId": "VmwareOperationsStatus_GetVmwareOperationStatus", "description": "A operation status resource belonging to a site resource.", "parameters": [ { @@ -12499,16 +12409,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "operationStatusName", "in": "path", - "required": true, "description": "Operation status Arm Name.", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -12539,10 +12449,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/runAsAccounts": { "get": { + "operationId": "RunAsAccountsController_ListByVmwareSite", "tags": [ "RunAsAccountsController" ], - "operationId": "RunAsAccountsController_ListByVmwareSite", "description": "List VmwareRunAsAccountResource resources by VmwareSite", "parameters": [ { @@ -12557,8 +12467,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -12592,10 +12502,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/runAsAccounts/{accountName}": { "get": { + "operationId": "RunAsAccountsController_Get", "tags": [ "RunAsAccountsController" ], - "operationId": "RunAsAccountsController_Get", "description": "Get a VmwareRunAsAccountResource", "parameters": [ { @@ -12610,16 +12520,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "accountName", "in": "path", - "required": true, "description": " RunAsAccounts name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -12650,10 +12560,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/serverGroupMembers": { "post": { + "operationId": "DependencyMapController_ServerGroupMembers", "tags": [ "DependencyMapController" ], - "operationId": "DependencyMapController_ServerGroupMembers", "description": "API to list server group members for the selected server group.", "parameters": [ { @@ -12668,16 +12578,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "mapRequest", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/DependencyMapServiceMapextensionsServerGroupMembersRequest" } @@ -12687,22 +12597,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -12729,10 +12637,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/summary": { "post": { + "operationId": "SitesController_Summary", "tags": [ "SitesController" ], - "operationId": "SitesController_Summary", "description": "Method to get site usage/summary.", "parameters": [ { @@ -12747,8 +12655,8 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -12779,10 +12687,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateDependencyMapStatus": { "post": { + "operationId": "VmwarePropertiesController_UpdateDependencyMapStatus", "tags": [ "VmwarePropertiesController" ], - "operationId": "VmwarePropertiesController_UpdateDependencyMapStatus", "description": "Method to enable disable dependency map status for machines\n in a\nsite.", "parameters": [ { @@ -12797,16 +12705,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "updateMachineDepMapStatus", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/UpdateMachineDepMapStatus" } @@ -12816,22 +12724,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -12858,10 +12764,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateProperties": { "post": { + "operationId": "VmwarePropertiesController_UpdateProperties", "tags": [ "VmwarePropertiesController" ], - "operationId": "VmwarePropertiesController_UpdateProperties", "description": "Method to update properties for machines in a site.", "parameters": [ { @@ -12876,16 +12782,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "metaData", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/MachineMetadataCollection" } @@ -12895,22 +12801,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "Resource operation accepted.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "Location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -12937,10 +12841,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateRunAsAccount": { "post": { + "operationId": "VmwarePropertiesController_UpdateRunAsAccount", "tags": [ "VmwarePropertiesController" ], - "operationId": "VmwarePropertiesController_UpdateRunAsAccount", "description": "Method to associate Run as account to machine\r\n in a site.", "parameters": [ { @@ -12955,16 +12859,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "updateMachineRunAsAccount", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/UpdateMachineRunAsAccount" } @@ -12974,22 +12878,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -13016,10 +12918,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateTags": { "post": { + "operationId": "VmwarePropertiesController_UpdateTags", "tags": [ "VmwarePropertiesController" ], - "operationId": "VmwarePropertiesController_UpdateTags", "description": "Method to associate Run as account to machine\r\n in a site.", "parameters": [ { @@ -13034,16 +12936,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "updateMachineTags", "in": "body", - "required": true, "description": "The content of the action request", + "required": true, "schema": { "$ref": "#/definitions/UpdateMachineTags" } @@ -13053,22 +12955,20 @@ "200": { "description": "ARM operation completed successfully.", "schema": { - "type": "object", - "properties": {}, - "x-typespec-name": "{}" + "type": "object" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." }, "location": { - "description": "The Location header contains the URL where the status of the long running operation can be checked.", - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." } } }, @@ -13095,10 +12995,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters": { "get": { + "operationId": "VcenterController_ListByVmwareSite", "tags": [ "VcenterController" ], - "operationId": "VcenterController_ListByVmwareSite", "description": "List Vcenter resources by VmwareSite", "parameters": [ { @@ -13113,15 +13013,15 @@ { "name": "filter", "in": "query", - "required": false, "description": "filter query", + "required": false, "type": "string" }, { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -13155,10 +13055,10 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/vcenters/{vcenterName}": { "get": { + "operationId": "VcenterController_Get", "tags": [ "VcenterController" ], - "operationId": "VcenterController_Get", "description": "Get a Vcenter", "parameters": [ { @@ -13173,16 +13073,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "vcenterName", "in": "path", - "required": true, "description": " VCenters name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -13211,10 +13111,10 @@ } }, "put": { + "operationId": "VcenterController_Create", "tags": [ "VcenterController" ], - "operationId": "VcenterController_Create", "description": "Create a Vcenter", "parameters": [ { @@ -13229,24 +13129,24 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "vcenterName", "in": "path", - "required": true, "description": " VCenters name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "body", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/Vcenter" } @@ -13261,15 +13161,15 @@ }, "201": { "description": "ARM create operation completed successfully.", + "schema": { + "$ref": "#/definitions/Vcenter" + }, "headers": { "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/Vcenter" } }, "default": { @@ -13293,10 +13193,10 @@ } }, "delete": { + "operationId": "VcenterController_Delete", "tags": [ "VcenterController" ], - "operationId": "VcenterController_Delete", "description": "Delete a Vcenter", "parameters": [ { @@ -13311,16 +13211,16 @@ { "name": "siteName", "in": "path", - "required": true, "description": "Site name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" }, { "name": "vcenterName", "in": "path", - "required": true, "description": " VCenters name", + "required": true, "type": "string", "pattern": "^[a-zA-Z0-9-]{3,24}$" } @@ -13353,6 +13253,7 @@ "definitions": { "Application": { "type": "object", + "description": "Application in the guest virtual machine.", "properties": { "name": { "type": "string", @@ -13369,11 +13270,11 @@ "description": "Gets or sets Provider of the Application.", "readOnly": true } - }, - "description": "Application in the guest virtual machine." + } }, "ApplicationDiscovery": { "type": "object", + "description": "Contains data related application and roles discovery scope.", "properties": { "discoveryScopeStatus": { "$ref": "#/definitions/ApplicationDiscoveryScopeStatus", @@ -13382,11 +13283,10 @@ }, "errors": { "type": "array", + "description": "Gets errors for discovery scope.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets errors for discovery scope.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "hydratedRunAsAccountId": { @@ -13394,8 +13294,7 @@ "description": "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials.", "readOnly": true } - }, - "description": "Contains data related application and roles discovery scope." + } }, "ApplicationDiscoveryScopeStatus": { "type": "string", @@ -13459,107 +13358,98 @@ }, "AppsAndRoles": { "type": "object", + "description": "AppsAndRoles in the guest virtual machine.", "properties": { "applications": { "type": "array", + "description": "Gets or sets Applications of the AppsAndRoles.", "items": { "$ref": "#/definitions/Application" }, - "x-ms-identifiers": [], - "description": "Gets or sets Applications of the AppsAndRoles.", - "x-typespec-name": "Application[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "webApplications": { "type": "array", + "description": "Gets or sets WebApplications of the AppsAndRoles.", "items": { "$ref": "#/definitions/WebApplicationAppsAndRolesModel" }, - "x-ms-identifiers": [], - "description": "Gets or sets WebApplications of the AppsAndRoles.", - "x-typespec-name": "WebApplicationAppsAndRolesModel[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "features": { "type": "array", + "description": "Gets or sets Features of the AppsAndRoles.", "items": { "$ref": "#/definitions/Feature" }, - "x-ms-identifiers": [], - "description": "Gets or sets Features of the AppsAndRoles.", - "x-typespec-name": "Feature[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "sqlServers": { "type": "array", + "description": "Gets or sets SQLServers of the AppsAndRoles.", "items": { "$ref": "#/definitions/SqlServerApplication" }, - "x-ms-identifiers": [], - "description": "Gets or sets SQLServers of the AppsAndRoles.", - "x-typespec-name": "SqlServerApplication[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "sharePointServers": { "type": "array", + "description": "Gets or sets SharePointServers of the AppsAndRoles.", "items": { "$ref": "#/definitions/SharePointServer" }, - "x-ms-identifiers": [], - "description": "Gets or sets SharePointServers of the AppsAndRoles.", - "x-typespec-name": "SharePointServer[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "systemCenters": { "type": "array", + "description": "Gets or sets SystemCenters of the AppsAndRoles.", "items": { "$ref": "#/definitions/SystemCenter" }, - "x-ms-identifiers": [], - "description": "Gets or sets SystemCenters of the AppsAndRoles.", - "x-typespec-name": "SystemCenter[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "bizTalkServers": { "type": "array", + "description": "Gets or sets BizTalkServers of the AppsAndRoles.", "items": { "$ref": "#/definitions/BizTalkServer" }, - "x-ms-identifiers": [], - "description": "Gets or sets BizTalkServers of the AppsAndRoles.", - "x-typespec-name": "BizTalkServer[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "exchangeServers": { "type": "array", + "description": "Gets or sets ExchangeServers of the AppsAndRoles.", "items": { "$ref": "#/definitions/ExchangeServer" }, - "x-ms-identifiers": [], - "description": "Gets or sets ExchangeServers of the AppsAndRoles.", - "x-typespec-name": "ExchangeServer[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "otherDatabases": { "type": "array", + "description": "Gets or sets OtherDatabaseServers of the AppsAndRoles.", "items": { "$ref": "#/definitions/OtherDatabase" }, - "x-ms-identifiers": [], - "description": "Gets or sets OtherDatabaseServers of the AppsAndRoles.", - "x-typespec-name": "OtherDatabase[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] } - }, - "description": "AppsAndRoles in the guest virtual machine." + } }, "Azure.ResourceManager.Object": { "type": "object", - "properties": {}, "description": "object model" }, "BizTalkServer": { "type": "object", + "description": "BizTalkServer in the guest virtual machine.", "properties": { "productName": { "type": "string", @@ -13571,23 +13461,21 @@ "description": "Gets or sets Status of the BizTalkServer.", "readOnly": true } - }, - "description": "BizTalkServer in the guest virtual machine." + } }, "ConnectorUnit": { "type": "object", + "description": "The connectors of the web server.", "properties": { "bindings": { "type": "array", + "description": "Gets or sets the bindings for the connector.", "items": { "$ref": "#/definitions/FrontEndBinding" }, - "x-ms-identifiers": [], - "description": "Gets or sets the bindings for the connector.", - "x-typespec-name": "FrontEndBinding[]" + "x-ms-identifiers": [] } - }, - "description": "The connectors of the web server." + } }, "Default": { "type": "string", @@ -13627,6 +13515,7 @@ }, "DeleteImportMachinesJob": { "type": "object", + "description": "A host resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/DeleteImportedMachinesJobProperties", @@ -13638,7 +13527,6 @@ ] } }, - "description": "A host resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -13647,14 +13535,14 @@ }, "DeleteImportMachinesJobCollection": { "type": "object", + "description": "Delete import machines job collection.", "properties": { "value": { "type": "array", + "description": "Gets the list of jobs.", "items": { "$ref": "#/definitions/DeleteImportMachinesJob" - }, - "description": "Gets the list of jobs.", - "x-typespec-name": "DeleteImportMachinesJob[]" + } }, "nextLink": { "type": "string", @@ -13662,13 +13550,13 @@ "readOnly": true } }, - "description": "Delete import machines job collection.", "required": [ "value" ] }, "DeleteImportedMachinesJobProperties": { "type": "object", + "description": "Delete Imported Machines Job Properties", "properties": { "blobName": { "type": "string", @@ -13693,11 +13581,10 @@ }, "errors": { "type": "array", + "description": "errors list", "items": { "type": "string" }, - "description": "errors list", - "x-typespec-name": "string[]", "readOnly": true }, "status": { @@ -13720,8 +13607,7 @@ "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "Delete Imported Machines Job Properties" + } }, "DeleteImportedMachinesJobPropertiesJobState": { "type": "string", @@ -13767,6 +13653,7 @@ }, "DependencyMapDiscovery": { "type": "object", + "description": "Contains data related dependency map discovery scope.", "properties": { "discoveryScopeStatus": { "$ref": "#/definitions/DependencyMapDiscoveryScopeStatus", @@ -13775,11 +13662,10 @@ }, "errors": { "type": "array", + "description": "Gets errors for discovery scope.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets errors for discovery scope.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "hydratedRunAsAccountId": { @@ -13787,8 +13673,7 @@ "description": "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials.", "readOnly": true } - }, - "description": "Contains data related dependency map discovery scope." + } }, "DependencyMapDiscoveryScopeStatus": { "type": "string", @@ -13852,6 +13737,7 @@ }, "DependencyMapMachineInput": { "type": "object", + "description": "Machine class.", "properties": { "machineId": { "type": "string", @@ -13861,11 +13747,11 @@ "type": "boolean", "description": "Gets or sets a value indicating whether\n dependency mapping is to\nbe enabled or not." } - }, - "description": "Machine class." + } }, "DependencyMapServiceMapextensionsClientGroupMembersRequest": { "type": "object", + "description": "DependencyMap ServiceMap extensions Client GroupMembers Request", "properties": { "machineId": { "type": "string", @@ -13893,33 +13779,31 @@ "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", "description": "optional filters" } - }, - "description": "DependencyMap ServiceMap extensions Client GroupMembers Request" + } }, "DependencyMapServiceMapextensionsDependencyMapRequestFilters": { "type": "object", + "description": "DependencyMap Service Map extensions Dependency Map Request Filters", "properties": { "machineIds": { "type": "array", + "description": "array of machine ids", "items": { "type": "string" - }, - "description": "array of machine ids", - "x-typespec-name": "string[]" + } }, "processIds": { "type": "array", + "description": "array of process Ids", "items": { "type": "string" - }, - "description": "array of process Ids", - "x-typespec-name": "string[]" + } } - }, - "description": "DependencyMap Service Map extensions Dependency Map Request Filters" + } }, "DependencyMapServiceMapextensionsExportDependenciesRequest": { "type": "object", + "description": "DependencyMap ServiceMap extensions ExportDependencies Request", "properties": { "startTime": { "type": "string", @@ -13931,11 +13815,11 @@ "format": "date-time", "description": "end time" } - }, - "description": "DependencyMap ServiceMap extensions ExportDependencies Request" + } }, "DependencyMapServiceMapextensionsScopeMapRequest": { "type": "object", + "description": "DependencyMap ServiceMapextensions Scope MapRequest", "properties": { "startTime": { "type": "string", @@ -13951,11 +13835,11 @@ "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", "description": "optional filters" } - }, - "description": "DependencyMap ServiceMapextensions Scope MapRequest" + } }, "DependencyMapServiceMapextensionsServerGroupMembersRequest": { "type": "object", + "description": "DependencyMap ServiceMap extensions ServerGroup Members Request", "properties": { "serverPort": { "type": "integer", @@ -13976,11 +13860,11 @@ "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", "description": "optional filters" } - }, - "description": "DependencyMap ServiceMap extensions ServerGroup Members Request" + } }, "DependencyMapServiceMapextensionsSingleMachineDetailedMapRequest": { "type": "object", + "description": "DependencyMap ServiceMap extensions SingleMachine DetailedMap Request", "properties": { "machineId": { "type": "string", @@ -14000,11 +13884,11 @@ "$ref": "#/definitions/DependencyMapServiceMapextensionsDependencyMapRequestFilters", "description": "optional filters" } - }, - "description": "DependencyMap ServiceMap extensions SingleMachine DetailedMap Request" + } }, "DirectoryPath": { "type": "object", + "description": "Second level entity for virtual directories.", "properties": { "virtual": { "type": "string", @@ -14014,11 +13898,11 @@ "type": "string", "description": "Gets or sets the physical path of the directory on the web server." } - }, - "description": "Second level entity for virtual directories." + } }, "DiscoveryScopeErrorSummary": { "type": "object", + "description": "The site error summary model.", "properties": { "affectedResourceType": { "type": "string", @@ -14034,7 +13918,6 @@ "description": "Gets or sets the count of affected objects." } }, - "description": "The site error summary model.", "required": [ "affectedResourceType", "affectedObjectsCount", @@ -14139,6 +14022,7 @@ }, "DiscoverySiteDataSource": { "type": "object", + "description": "Web app data source web model.", "properties": { "properties": { "$ref": "#/definitions/DiscoverySiteDataSourceProperties", @@ -14150,7 +14034,6 @@ ] } }, - "description": "Web app data source web model.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -14159,29 +14042,28 @@ }, "DiscoverySiteDataSourceListResult": { "type": "object", + "description": "The response of a DiscoverySiteDataSource list operation.", "properties": { "value": { "type": "array", + "description": "The DiscoverySiteDataSource items on this page", "items": { "$ref": "#/definitions/DiscoverySiteDataSource" - }, - "description": "The DiscoverySiteDataSource items on this page", - "x-typespec-name": "DiscoverySiteDataSource[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a DiscoverySiteDataSource list operation.", "required": [ "value" ] }, "DiscoverySiteDataSourceProperties": { "type": "object", + "description": "Discovery site data source properties class.", "properties": { "discoverySiteId": { "type": "string", @@ -14192,11 +14074,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Discovery site data source properties class." + } }, "ErrorDetails": { "type": "object", + "description": "Error contract returned when some exception occurs in Rest API.", "properties": { "code": { "type": "string", @@ -14248,21 +14130,21 @@ "description": "Gets the recommended action for the agent error.", "readOnly": true } - }, - "description": "Error contract returned when some exception occurs in Rest API." + } }, "ErrorSummaryRequest": { "type": "object", + "description": "ErrorSummaryRequest body", "properties": { "applianceName": { "type": "string", "description": "Gets or sets the Appliance Name." } - }, - "description": "ErrorSummaryRequest body" + } }, "Errors": { "type": "object", + "description": "The properties of a server machine tracked resource", "properties": { "message": { "type": "string", @@ -14271,11 +14153,10 @@ }, "messageParameters": { "type": "object", + "description": "Gets the message parameters.", "additionalProperties": { "type": "string" }, - "description": "Gets the message parameters.", - "x-typespec-name": "Record", "readOnly": true }, "applianceName": { @@ -14335,11 +14216,11 @@ "description": "Gets discovery scope for which error is encountered.", "readOnly": true } - }, - "description": "The properties of a server machine tracked resource" + } }, "ExchangeServer": { "type": "object", + "description": "ExchangeServer in the guest virtual machine.", "properties": { "productName": { "type": "string", @@ -14366,11 +14247,11 @@ "description": "Gets or sets Version of the ExchangeServer.", "readOnly": true } - }, - "description": "ExchangeServer in the guest virtual machine." + } }, "ExportImportedMachinesJob": { "type": "object", + "description": "Export machines job REST resource.", "properties": { "type": { "type": "string", @@ -14405,11 +14286,11 @@ "type": "string", "description": "Gets or sets the Display name." } - }, - "description": "Export machines job REST resource." + } }, "ExportImportedMachinesJobEntityProperties": { "type": "object", + "description": " Export Imported Machines JobEntity Properties ", "properties": { "blobName": { "type": "string", @@ -14419,8 +14300,7 @@ "type": "string", "description": "sas uri" } - }, - "description": " Export Imported Machines JobEntity Properties " + } }, "ExportMachineErrorsProperties": { "type": "string", @@ -14460,26 +14340,27 @@ }, "ExportMachineErrorsRequest": { "type": "object", + "description": "The body of export machine errors request.", "properties": { "properties": { "$ref": "#/definitions/RequestExportMachineErrorsProperties", "description": "Gets or sets the properties." } - }, - "description": "The body of export machine errors request." + } }, "ExportMachinesRequest": { "type": "object", + "description": "ExportMachinesRequest body", "properties": { "filter": { "type": "string", "description": "filter options." } - }, - "description": "ExportMachinesRequest body" + } }, "ExportSqlServersRequest": { "type": "object", + "description": "ExportSqlServerRequest body", "properties": { "applianceName": { "type": "string", @@ -14489,18 +14370,17 @@ "type": "string", "description": "filter options." } - }, - "description": "ExportSqlServerRequest body" + } }, "ExportWebAppsRequest": { "type": "object", + "description": "ExportWebAppsRequest body", "properties": { "filter": { "type": "string", "description": "filter options." } - }, - "description": "ExportWebAppsRequest body" + } }, "FCIInstanceState": { "type": "string", @@ -14570,6 +14450,7 @@ }, "Feature": { "type": "object", + "description": "Feature in the guest virtual machine.", "properties": { "name": { "type": "string", @@ -14591,11 +14472,11 @@ "description": "Gets or sets Status of the Feature.", "readOnly": true } - }, - "description": "Feature in the guest virtual machine." + } }, "FileMetaData": { "type": "object", + "description": "File Metadata web model.", "properties": { "logicalName": { "type": "string", @@ -14618,8 +14499,7 @@ "type": "boolean", "description": "Gets or sets a value indicating whether memory optimized data option is enabled." } - }, - "description": "File Metadata web model." + } }, "FileType": { "type": "string", @@ -14665,6 +14545,7 @@ }, "FrontEndBinding": { "type": "object", + "description": "Frontend bindings for a web application.", "properties": { "protocol": { "type": "string", @@ -14682,11 +14563,11 @@ "type": "string", "description": "Gets or sets the IP Address." } - }, - "description": "Frontend bindings for a web application." + } }, "GuestOsDetails": { "type": "object", + "description": "Second level object. Data related to a machine's operating system. Serialized and stored as part of Machine Rest object. ", "properties": { "osType": { "type": "string", @@ -14704,11 +14585,11 @@ "type": "string", "description": "Gets or sets the Architecture of the operating system." } - }, - "description": "Second level object. Data related to a machine's operating system. Serialized and stored as part of Machine Rest object. " + } }, "HealthErrorDetails": { "type": "object", + "description": "Error contract returned when some exception occurs in Rest API.", "properties": { "message": { "type": "string", @@ -14717,11 +14598,10 @@ }, "messageParameters": { "type": "object", + "description": "Gets the message parameters.", "additionalProperties": { "type": "string" }, - "description": "Gets the message parameters.", - "x-typespec-name": "Record", "readOnly": true }, "applianceName": { @@ -14781,8 +14661,7 @@ "description": "Gets discovery scope for which error is encountered.", "readOnly": true } - }, - "description": "Error contract returned when some exception occurs in Rest API." + } }, "HealthErrorDetailsDiscoveryScope": { "type": "string", @@ -14918,6 +14797,7 @@ }, "HypervCluster": { "type": "object", + "description": "A cluster resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/HypervClusterProperties", @@ -14929,7 +14809,6 @@ ] } }, - "description": "A cluster resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -14938,29 +14817,28 @@ }, "HypervClusterListResult": { "type": "object", + "description": "The response of a HypervCluster list operation.", "properties": { "value": { "type": "array", + "description": "The HypervCluster items on this page", "items": { "$ref": "#/definitions/HypervCluster" - }, - "description": "The HypervCluster items on this page", - "x-typespec-name": "HypervCluster[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a HypervCluster list operation.", "required": [ "value" ] }, "HypervClusterProperties": { "type": "object", + "description": "The properties of Hyperv Cluster", "properties": { "createdTimestamp": { "type": "string", @@ -14993,30 +14871,28 @@ }, "hostFqdnList": { "type": "array", + "description": "Gets or sets list of hosts (FQDN) currently being tracked by the cluster.", "items": { "type": "string" - }, - "description": "Gets or sets list of hosts (FQDN) currently being tracked by the cluster.", - "x-typespec-name": "string[]" + } }, "errors": { "type": "array", + "description": "Gets the errors.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets the errors.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "The properties of Hyperv Cluster" + } }, "HypervDisk": { "type": "object", + "description": "Second level object returned as part of Machine REST resource.", "properties": { "instanceId": { "type": "string", @@ -15050,11 +14926,11 @@ "type": "string", "description": "Gets or sets Path of the disk." } - }, - "description": "Second level object returned as part of Machine REST resource." + } }, "HypervHost": { "type": "object", + "description": "A host resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/HypervHostProperties", @@ -15066,7 +14942,6 @@ ] } }, - "description": "A host resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -15075,29 +14950,28 @@ }, "HypervHostListResult": { "type": "object", + "description": "The response of a HypervHost list operation.", "properties": { "value": { "type": "array", + "description": "The HypervHost items on this page", "items": { "$ref": "#/definitions/HypervHost" - }, - "description": "The HypervHost items on this page", - "x-typespec-name": "HypervHost[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a HypervHost list operation.", "required": [ "value" ] }, "HypervHostProperties": { "type": "object", + "description": "The properties of Hyperv Host", "properties": { "createdTimestamp": { "type": "string", @@ -15124,22 +14998,21 @@ }, "errors": { "type": "array", + "description": "Gets the errors.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets the errors.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "The properties of Hyperv Host" + } }, "HypervJob": { "type": "object", + "description": "A job resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/JobProperties", @@ -15151,7 +15024,6 @@ ] } }, - "description": "A job resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -15160,29 +15032,28 @@ }, "HypervJobListResult": { "type": "object", + "description": "The response of a HypervJob list operation.", "properties": { "value": { "type": "array", + "description": "The HypervJob items on this page", "items": { "$ref": "#/definitions/HypervJob" - }, - "description": "The HypervJob items on this page", - "x-typespec-name": "HypervJob[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a HypervJob list operation.", "required": [ "value" ] }, "HypervMachine": { "type": "object", + "description": "A machine resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/HypervMachineProperties", @@ -15194,7 +15065,6 @@ ] } }, - "description": "A machine resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -15203,29 +15073,28 @@ }, "HypervMachineListResult": { "type": "object", + "description": "The response of a HypervMachine list operation.", "properties": { "value": { "type": "array", + "description": "The HypervMachine items on this page", "items": { "$ref": "#/definitions/HypervMachine" - }, - "description": "The HypervMachine items on this page", - "x-typespec-name": "HypervMachine[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a HypervMachine list operation.", "required": [ "value" ] }, "HypervMachineProperties": { "type": "object", + "description": "The properties of AddressResource", "properties": { "instanceUuid": { "type": "string", @@ -15281,23 +15150,21 @@ }, "disks": { "type": "array", + "description": "Disks attached to the machine.", "items": { "$ref": "#/definitions/HypervDisk" }, - "x-ms-identifiers": [], - "description": "Disks attached to the machine.", - "x-typespec-name": "HypervDisk[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "networkAdapters": { "type": "array", + "description": "Network adapters attached to the machine.", "items": { "$ref": "#/definitions/HypervNetworkAdapter" }, - "x-ms-identifiers": [], - "description": "Network adapters attached to the machine.", - "x-typespec-name": "HypervNetworkAdapter[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "managementServerType": { "type": "string", @@ -15412,20 +15279,18 @@ }, "applianceNames": { "type": "array", + "description": "Gets the appliance names.", "items": { "type": "string" }, - "description": "Gets the appliance names.", - "x-typespec-name": "string[]", "readOnly": true }, "errors": { "type": "array", + "description": "Errors for machine.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Errors for machine.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "applicationDiscovery": { @@ -15521,11 +15386,10 @@ }, "tags": { "type": "object", + "description": "Gets or sets tags on the resource.", "additionalProperties": { "type": "string" - }, - "description": "Gets or sets tags on the resource.", - "x-typespec-name": "Record" + } }, "updatedTimestamp": { "type": "string", @@ -15537,21 +15401,21 @@ "description": "The status of the last operation.", "readOnly": true } - }, - "description": "The properties of AddressResource" + } }, "HypervMachineUpdate": { "type": "object", + "description": "The type used for update operations of the HypervMachine.", "properties": { "properties": { "$ref": "#/definitions/HypervMachineUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the HypervMachine." + } }, "HypervMachineUpdateProperties": { "type": "object", + "description": "The updatable properties of the HypervMachine.", "properties": { "firmware": { "type": "string", @@ -15589,17 +15453,16 @@ }, "tags": { "type": "object", + "description": "Gets or sets tags on the resource.", "additionalProperties": { "type": "string" - }, - "description": "Gets or sets tags on the resource.", - "x-typespec-name": "Record" + } } - }, - "description": "The updatable properties of the HypervMachine." + } }, "HypervNetworkAdapter": { "type": "object", + "description": "Second level object represented in responses as part of Machine REST resource.", "properties": { "networkId": { "type": "string", @@ -15631,11 +15494,10 @@ }, "ipAddressList": { "type": "array", + "description": "Gets IP addresses for the machine.", "items": { "type": "string" }, - "description": "Gets IP addresses for the machine.", - "x-typespec-name": "string[]", "readOnly": true }, "networkName": { @@ -15646,11 +15508,11 @@ "type": "string", "description": "Gets or sets Type of the IP address." } - }, - "description": "Second level object represented in responses as part of Machine REST resource." + } }, "HypervOperationsStatusResource": { "type": "object", + "description": "A cluster resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/HypervClusterProperties", @@ -15662,7 +15524,6 @@ ] } }, - "description": "A cluster resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -15671,6 +15532,7 @@ }, "HypervRunAsAccountResource": { "type": "object", + "description": "A machine resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/RunAsAccountProperties", @@ -15682,7 +15544,6 @@ ] } }, - "description": "A machine resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -15691,29 +15552,28 @@ }, "HypervRunAsAccountResourceListResult": { "type": "object", + "description": "The response of a HypervRunAsAccountResource list operation.", "properties": { "value": { "type": "array", + "description": "The HypervRunAsAccountResource items on this page", "items": { "$ref": "#/definitions/HypervRunAsAccountResource" - }, - "description": "The HypervRunAsAccountResource items on this page", - "x-typespec-name": "HypervRunAsAccountResource[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a HypervRunAsAccountResource list operation.", "required": [ "value" ] }, "HypervSite": { "type": "object", + "description": "A HyperV SiteResource", "properties": { "properties": { "$ref": "#/definitions/SiteProperties", @@ -15725,7 +15585,6 @@ ] } }, - "description": "A HyperV SiteResource", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -15734,47 +15593,45 @@ }, "HypervSiteListResult": { "type": "object", + "description": "The response of a HypervSite list operation.", "properties": { "value": { "type": "array", + "description": "The HypervSite items on this page", "items": { "$ref": "#/definitions/HypervSite" - }, - "description": "The HypervSite items on this page", - "x-typespec-name": "HypervSite[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a HypervSite list operation.", "required": [ "value" ] }, "HypervSiteUpdate": { "type": "object", + "description": "The type used for update operations of the HypervSite.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } }, "properties": { "$ref": "#/definitions/HypervSiteUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the HypervSite." + } }, "HypervSiteUpdateProperties": { "type": "object", + "description": "The updatable properties of the HypervSite.", "properties": { "servicePrincipalIdentityDetails": { "$ref": "#/definitions/SiteSpnProperties", @@ -15796,11 +15653,11 @@ "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "The updatable properties of the HypervSite." + } }, "HypervSiteUsage": { "type": "object", + "description": "Hyper-V site usage.", "properties": { "machineCount": { "type": "integer", @@ -15822,11 +15679,11 @@ "format": "int32", "description": "Gets or sets the number of clusters part of the site." } - }, - "description": "Hyper-V site usage." + } }, "HypervVmSoftwareInventory": { "type": "object", + "description": "HyperV VM software inventory REST resource.", "properties": { "properties": { "$ref": "#/definitions/MachineSoftwareInventoryProperties", @@ -15838,7 +15695,6 @@ ] } }, - "description": "HyperV VM software inventory REST resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -15847,29 +15703,28 @@ }, "HypervVmSoftwareInventoryListResult": { "type": "object", + "description": "The response of a HypervVmSoftwareInventory list operation.", "properties": { "value": { "type": "array", + "description": "The HypervVmSoftwareInventory items on this page", "items": { "$ref": "#/definitions/HypervVmSoftwareInventory" - }, - "description": "The HypervVmSoftwareInventory items on this page", - "x-typespec-name": "HypervVmSoftwareInventory[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a HypervVmSoftwareInventory list operation.", "required": [ "value" ] }, "IisApplicationUnit": { "type": "object", + "description": "Second-level object for identification of application units in a web site\nhosted on IIS.", "properties": { "applicationPoolName": { "type": "string", @@ -15893,18 +15748,17 @@ }, "directories": { "type": "array", + "description": "Gets or sets the list of directories.", "items": { "$ref": "#/definitions/DirectoryPath" }, - "x-ms-identifiers": [], - "description": "Gets or sets the list of directories.", - "x-typespec-name": "DirectoryPath[]" + "x-ms-identifiers": [] } - }, - "description": "Second-level object for identification of application units in a web site\nhosted on IIS." + } }, "IisVirtualApplicationUnit": { "type": "object", + "description": "Second-level object for identification of virtual applications in a web site\nhosted on IIS.", "properties": { "isVirtualDirectory": { "type": "boolean", @@ -15917,38 +15771,35 @@ }, "directories": { "type": "array", + "description": "Gets or sets the list of directories.", "items": { "$ref": "#/definitions/DirectoryPath" }, - "x-ms-identifiers": [], - "description": "Gets or sets the list of directories.", - "x-typespec-name": "DirectoryPath[]" + "x-ms-identifiers": [] } - }, - "description": "Second-level object for identification of virtual applications in a web site\nhosted on IIS." + } }, "IisWebApplicationProperties": { "type": "object", + "description": "Class for web application properties.", "properties": { "applications": { "type": "array", + "description": "Gets the list of application units for the web site.", "items": { "$ref": "#/definitions/IisApplicationUnit" }, - "x-ms-identifiers": [], - "description": "Gets the list of application units for the web site.", - "x-typespec-name": "IisApplicationUnit[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "virtualApplications": { "type": "array", + "description": "Gets the list of application units for the web site.", "items": { "$ref": "#/definitions/IisVirtualApplicationUnit" }, - "x-ms-identifiers": [], - "description": "Gets the list of application units for the web site.", - "x-typespec-name": "IisVirtualApplicationUnit[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "webServerId": { "type": "string", @@ -15960,6 +15811,14 @@ "description": "Gets the web server name.", "readOnly": true }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the SQL server is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, "virtualPath": { "type": "string", "description": "Gets the virtual path of the application.", @@ -15972,43 +15831,39 @@ }, "bindings": { "type": "array", + "description": "Gets the front end bindings for the application.", "items": { "$ref": "#/definitions/FrontEndBinding" }, - "x-ms-identifiers": [], - "description": "Gets the front end bindings for the application.", - "x-typespec-name": "FrontEndBinding[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "frameworks": { "type": "array", + "description": "Gets the Error details.", "items": { "$ref": "#/definitions/WebApplicationFramework" }, - "x-ms-identifiers": [], - "description": "Gets the Error details.", - "x-typespec-name": "WebApplicationFramework[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "configurations": { "type": "array", + "description": "Gets the configuration.", "items": { "$ref": "#/definitions/WebApplicationConfigurationUnit" }, - "x-ms-identifiers": [], - "description": "Gets the configuration.", - "x-typespec-name": "WebApplicationConfigurationUnit[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "directories": { "type": "array", + "description": "Gets the directories.", "items": { "$ref": "#/definitions/WebApplicationDirectoryUnit" }, - "description": "Gets the directories.", - "x-typespec-name": "WebApplicationDirectoryUnit[]", - "x-ms-identifiers": [], - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "displayName": { "type": "string", @@ -16017,19 +15872,17 @@ }, "tags": { "type": "object", + "description": "Gets or sets tags on the resource.", "additionalProperties": { "type": "string" - }, - "description": "Gets or sets tags on the resource.", - "x-typespec-name": "Record" + } }, "staticFolders": { "type": "array", + "description": "Static folders.", "items": { "type": "string" }, - "description": "Static folders.", - "x-typespec-name": "string[]", "readOnly": true }, "machineDisplayName": { @@ -16059,20 +15912,18 @@ }, "errors": { "type": "array", + "description": "Gets the Error details.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets the Error details.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "applianceNames": { "type": "array", + "description": "Gets the appliance names.", "items": { "type": "string" }, - "description": "Gets the appliance names.", - "x-typespec-name": "string[]", "readOnly": true }, "hasErrors": { @@ -16085,11 +15936,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for web application properties." + } }, "IisWebApplications": { "type": "object", + "description": "Web application REST Resource.", "properties": { "properties": { "$ref": "#/definitions/IisWebApplicationProperties", @@ -16101,7 +15952,6 @@ ] } }, - "description": "Web application REST Resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -16110,53 +15960,51 @@ }, "IisWebApplicationsListResult": { "type": "object", + "description": "The response of a IisWebApplications list operation.", "properties": { "value": { "type": "array", + "description": "The IisWebApplications items on this page", "items": { "$ref": "#/definitions/IisWebApplications" - }, - "description": "The IisWebApplications items on this page", - "x-typespec-name": "IisWebApplications[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a IisWebApplications list operation.", "required": [ "value" ] }, "IisWebApplicationsUpdate": { "type": "object", + "description": "The type used for update operations of the IisWebApplications.", "properties": { "properties": { "$ref": "#/definitions/IisWebApplicationsUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the IisWebApplications." + } }, "IisWebApplicationsUpdateProperties": { "type": "object", + "description": "The updatable properties of the IisWebApplications.", "properties": { "tags": { "type": "object", + "description": "Gets or sets tags on the resource.", "additionalProperties": { "type": "string" - }, - "description": "Gets or sets tags on the resource.", - "x-typespec-name": "Record" + } } - }, - "description": "The updatable properties of the IisWebApplications." + } }, "IisWebServerProperties": { "type": "object", + "description": "Class for web server properties.", "properties": { "configurationLocation": { "type": "string", @@ -16170,20 +16018,18 @@ }, "machineIds": { "type": "array", + "description": "Gets the list of machines.", "items": { "type": "string" }, - "description": "Gets the list of machines.", - "x-typespec-name": "string[]", "readOnly": true }, "webApplications": { "type": "array", + "description": "Gets the list of web applications.", "items": { "type": "string" }, - "description": "Gets the list of web applications.", - "x-typespec-name": "string[]", "readOnly": true }, "displayName": { @@ -16223,20 +16069,18 @@ }, "errors": { "type": "array", + "description": "Gets the Error details.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets the Error details.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "applianceNames": { "type": "array", + "description": "Gets the appliance names.", "items": { "type": "string" }, - "description": "Gets the appliance names.", - "x-typespec-name": "string[]", "readOnly": true }, "hasErrors": { @@ -16249,11 +16093,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for web server properties." + } }, "IisWebServers": { "type": "object", + "description": "Web server REST Resource.", "properties": { "properties": { "$ref": "#/definitions/IisWebServerProperties", @@ -16265,7 +16109,6 @@ ] } }, - "description": "Web server REST Resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -16274,29 +16117,28 @@ }, "IisWebServersListResult": { "type": "object", + "description": "The response of a IisWebServers list operation.", "properties": { "value": { "type": "array", + "description": "The IisWebServers items on this page", "items": { "$ref": "#/definitions/IisWebServers" - }, - "description": "The IisWebServers items on this page", - "x-typespec-name": "IisWebServers[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a IisWebServers list operation.", "required": [ "value" ] }, "ImportJob": { "type": "object", + "description": "A host resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/JobProperties", @@ -16308,7 +16150,6 @@ ] } }, - "description": "A host resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -16317,29 +16158,28 @@ }, "ImportJobListResult": { "type": "object", + "description": "The response of a ImportJob list operation.", "properties": { "value": { "type": "array", + "description": "The ImportJob items on this page", "items": { "$ref": "#/definitions/ImportJob" - }, - "description": "The ImportJob items on this page", - "x-typespec-name": "ImportJob[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a ImportJob list operation.", "required": [ "value" ] }, "ImportMachine": { "type": "object", + "description": "An machine resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/ImportMachineProperties", @@ -16351,7 +16191,6 @@ ] } }, - "description": "An machine resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -16360,29 +16199,28 @@ }, "ImportMachineListResult": { "type": "object", + "description": "The response of a ImportMachine list operation.", "properties": { "value": { "type": "array", + "description": "The ImportMachine items on this page", "items": { "$ref": "#/definitions/ImportMachine" - }, - "description": "The ImportMachine items on this page", - "x-typespec-name": "ImportMachine[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a ImportMachine list operation.", "required": [ "value" ] }, "ImportMachineProperties": { "type": "object", + "description": "Class for machine properties.", "properties": { "firmware": { "type": "string", @@ -16438,11 +16276,10 @@ }, "ipAddresses": { "type": "array", + "description": "IP Addresses.", "items": { "type": "string" }, - "description": "IP Addresses.", - "x-typespec-name": "string[]", "readOnly": true }, "machineId": { @@ -16490,15 +16327,14 @@ }, "disks": { "type": "array", + "description": "Disks attached to the machine.", "items": { "$ref": "#/definitions/WebRoleImportDisk" }, + "readOnly": true, "x-ms-identifiers": [ "name" - ], - "description": "Disks attached to the machine.", - "x-typespec-name": "WebRoleImportDisk[]", - "readOnly": true + ] }, "vmFqdn": { "type": "string", @@ -16555,24 +16391,23 @@ }, "tags": { "type": "object", + "description": "machine tags", "additionalProperties": { "type": "string" - }, - "description": "machine tags", - "x-typespec-name": "Record" + } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } }, - "description": "Class for machine properties.", "required": [ "tags" ] }, "ImportMachinesJob": { "type": "object", + "description": "Import machines Job REST Resource.", "properties": { "type": { "type": "string", @@ -16607,11 +16442,11 @@ "type": "string", "description": "Gets or sets the Display name." } - }, - "description": "Import machines Job REST Resource." + } }, "ImportMachinesJobProperties": { "type": "object", + "description": "ImportMachines JobProperties", "properties": { "blobName": { "type": "string", @@ -16639,11 +16474,11 @@ "$ref": "#/definitions/JobErrorSummary", "description": "error summary" } - }, - "description": "ImportMachines JobProperties" + } }, "ImportSite": { "type": "object", + "description": "A ImportSite", "properties": { "properties": { "$ref": "#/definitions/ImportSiteProperties", @@ -16655,7 +16490,6 @@ ] } }, - "description": "A ImportSite", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -16664,29 +16498,28 @@ }, "ImportSiteListResult": { "type": "object", + "description": "The response of a ImportSite list operation.", "properties": { "value": { "type": "array", + "description": "The ImportSite items on this page", "items": { "$ref": "#/definitions/ImportSite" - }, - "description": "The ImportSite items on this page", - "x-typespec-name": "ImportSite[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a ImportSite list operation.", "required": [ "value" ] }, "ImportSiteProperties": { "type": "object", + "description": "The properties of ImportSiteResource", "properties": { "discoverySolutionId": { "type": "string", @@ -16706,29 +16539,28 @@ "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "The properties of ImportSiteResource" + } }, "ImportSiteUpdate": { "type": "object", + "description": "The type used for update operations of the ImportSite.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } }, "properties": { "$ref": "#/definitions/ImportSiteUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the ImportSite." + } }, "ImportSiteUpdateProperties": { "type": "object", + "description": "The updatable properties of the ImportSite.", "properties": { "discoverySolutionId": { "type": "string", @@ -16738,19 +16570,18 @@ "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "The updatable properties of the ImportSite." + } }, "JobErrorSummary": { "type": "object", + "description": "Job Error Summary", "properties": { "errors": { "type": "array", + "description": "errors list", "items": { "type": "string" - }, - "description": "errors list", - "x-typespec-name": "string[]" + } }, "errorCount": { "type": "integer", @@ -16762,11 +16593,11 @@ "format": "int32", "description": "warning Count" } - }, - "description": "Job Error Summary" + } }, "JobProperties": { "type": "object", + "description": "Job REST Resource.", "properties": { "status": { "type": "string", @@ -16800,21 +16631,19 @@ }, "errors": { "type": "array", + "description": "Gets the errors.", "items": { "$ref": "#/definitions/ErrorDetails" }, - "x-ms-identifiers": [], - "description": "Gets the errors.", - "x-typespec-name": "ErrorDetails[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation.", "readOnly": true } - }, - "description": "Job REST Resource." + } }, "JobResult": { "type": "string", @@ -16872,6 +16701,7 @@ }, "MachineMetadata": { "type": "object", + "description": "The properties of Machine MetaData", "properties": { "machineArmId": { "type": "string", @@ -16883,14 +16713,12 @@ }, "tags": { "type": "object", + "description": "machine tags", "additionalProperties": { "type": "string" - }, - "description": "machine tags", - "x-typespec-name": "Record" + } } }, - "description": "The properties of Machine MetaData", "required": [ "machineArmId", "dependencyMapping", @@ -16899,24 +16727,24 @@ }, "MachineMetadataCollection": { "type": "object", + "description": "The list of Machine MetaData.", "properties": { "value": { "type": "array", + "description": "The list of Machine MetaData.", "items": { "$ref": "#/definitions/MachineMetadata" }, - "x-ms-identifiers": [], - "description": "The list of Machine MetaData.", - "x-typespec-name": "MachineMetadata[]" + "x-ms-identifiers": [] } }, - "description": "The list of Machine MetaData.", "required": [ "value" ] }, "MachineResource": { "type": "object", + "description": "An machine resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/VmwareMachineProperties", @@ -16928,7 +16756,6 @@ ] } }, - "description": "An machine resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -16937,39 +16764,38 @@ }, "MachineResourceListResult": { "type": "object", + "description": "The response of a MachineResource list operation.", "properties": { "value": { "type": "array", + "description": "The MachineResource items on this page", "items": { "$ref": "#/definitions/MachineResource" - }, - "description": "The MachineResource items on this page", - "x-typespec-name": "MachineResource[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a MachineResource list operation.", "required": [ "value" ] }, "MachineResourceUpdate": { "type": "object", + "description": "The type used for update operations of the MachineResource.", "properties": { "properties": { "$ref": "#/definitions/MachineResourceUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the MachineResource." + } }, "MachineResourceUpdateProperties": { "type": "object", + "description": "The updatable properties of the MachineResource.", "properties": { "firmware": { "type": "string", @@ -17007,17 +16833,16 @@ }, "tags": { "type": "object", + "description": "Gets or sets tags on the VMware machine.", "additionalProperties": { "type": "string" - }, - "description": "Gets or sets tags on the VMware machine.", - "x-typespec-name": "Record" + } } - }, - "description": "The updatable properties of the MachineResource." + } }, "MachineSoftwareInventoryProperties": { "type": "object", + "description": "Class for machine software inventory properties.", "properties": { "appsAndRoles": { "$ref": "#/definitions/AppsAndRoles", @@ -17029,11 +16854,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for machine software inventory properties." + } }, "MasterSite": { "type": "object", + "description": "A MasterSite", "properties": { "properties": { "$ref": "#/definitions/MasterSiteProperties", @@ -17045,7 +16870,6 @@ ] } }, - "description": "A MasterSite", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -17054,29 +16878,28 @@ }, "MasterSiteListResult": { "type": "object", + "description": "The response of a MasterSite list operation.", "properties": { "value": { "type": "array", + "description": "The MasterSite items on this page", "items": { "$ref": "#/definitions/MasterSite" - }, - "description": "The MasterSite items on this page", - "x-typespec-name": "MasterSite[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a MasterSite list operation.", "required": [ "value" ] }, "MasterSiteProperties": { "type": "object", + "description": "Class for site properties.", "properties": { "publicNetworkAccess": { "$ref": "#/definitions/MasterSitePropertiesPublicNetworkAccess", @@ -17088,11 +16911,10 @@ }, "sites": { "type": "array", + "description": "Gets or sets the sites that are a part of Master Site.\n The key\nshould contain the Site ARM name.", "items": { "type": "string" - }, - "description": "Gets or sets the sites that are a part of Master Site.\n The key\nshould contain the Site ARM name.", - "x-typespec-name": "string[]" + } }, "customerStorageAccountArmId": { "type": "string", @@ -17100,20 +16922,18 @@ }, "privateEndpointConnections": { "type": "array", + "description": "Gets the private endpoint connections.", "items": { "$ref": "#/definitions/PrivateEndpointConnection" }, - "description": "Gets the private endpoint connections.", - "x-typespec-name": "PrivateEndpointConnection[]", "readOnly": true }, "nestedSites": { "type": "array", + "description": "Gets the nested sites under Master Site.", "items": { "type": "string" }, - "description": "Gets the nested sites under Master Site.", - "x-typespec-name": "string[]", "readOnly": true }, "provisioningState": { @@ -17121,8 +16941,7 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for site properties." + } }, "MasterSitePropertiesPublicNetworkAccess": { "type": "string", @@ -17156,24 +16975,24 @@ }, "MasterSiteUpdate": { "type": "object", + "description": "The type used for update operations of the MasterSite.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } }, "properties": { "$ref": "#/definitions/MasterSiteUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the MasterSite." + } }, "MasterSiteUpdateProperties": { "type": "object", + "description": "The updatable properties of the MasterSite.", "properties": { "publicNetworkAccess": { "$ref": "#/definitions/MasterSitePropertiesPublicNetworkAccess", @@ -17185,18 +17004,16 @@ }, "sites": { "type": "array", + "description": "Gets or sets the sites that are a part of Master Site.\n The key\nshould contain the Site ARM name.", "items": { "type": "string" - }, - "description": "Gets or sets the sites that are a part of Master Site.\n The key\nshould contain the Site ARM name.", - "x-typespec-name": "string[]" + } }, "customerStorageAccountArmId": { "type": "string", "description": "Gets or sets a value for customer storage account ARM id." } - }, - "description": "The updatable properties of the MasterSite." + } }, "MicrosoftAzureFDSWebRoleHealthErrorDetailsSource": { "type": "string", @@ -17230,11 +17047,11 @@ }, "Object": { "type": "object", - "properties": {}, "description": "object model" }, "OperatingSystem": { "type": "object", + "description": "Second level object returned as part of Machine REST resource.", "properties": { "osType": { "type": "string", @@ -17252,11 +17069,11 @@ "type": "string", "description": "Gets or sets the Architecture of the operating system." } - }, - "description": "Second level object returned as part of Machine REST resource." + } }, "OperationStatus": { "type": "object", + "description": "Operation status REST resource.", "properties": { "id": { "type": "string", @@ -17293,11 +17110,11 @@ "description": "Operation status properties", "readOnly": true } - }, - "description": "Operation status REST resource." + } }, "OperationStatusError": { "type": "object", + "description": "Class for operation status errors.", "properties": { "code": { "type": "string", @@ -17309,21 +17126,21 @@ "description": "Gets the error message.", "readOnly": true } - }, - "description": "Class for operation status errors." + } }, "OperationStatusProperties": { "type": "object", + "description": "Class for operation result properties.", "properties": { "result": { "type": "string", "description": "Gets or sets the result or output of the workflow." } - }, - "description": "Class for operation result properties." + } }, "OracleDiscovery": { "type": "object", + "description": "Data related to a machine's Oracle discovery.", "properties": { "totalInstanceCount": { "type": "integer", @@ -17343,11 +17160,11 @@ "$ref": "#/definitions/DiscoveryScopeStatus", "description": "Gets or sets status of partner discovery." } - }, - "description": "Data related to a machine's Oracle discovery." + } }, "OtherDatabase": { "type": "object", + "description": "OtherDatabase in the guest virtual machine.", "properties": { "databaseType": { "type": "string", @@ -17364,74 +17181,71 @@ "description": "Gets or sets Version of the OtherDatabase.", "readOnly": true } - }, - "description": "OtherDatabase in the guest virtual machine." + } }, "PagedDeleteImportMachinesJob": { "type": "object", + "description": "Paged collection of DeleteImportMachinesJob items", "properties": { "value": { "type": "array", + "description": "The DeleteImportMachinesJob items on this page", "items": { "$ref": "#/definitions/DeleteImportMachinesJob" }, - "description": "The DeleteImportMachinesJob items on this page", - "x-typespec-name": "DeleteImportMachinesJob[]", - "x-ms-identifiers": [], - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "nextLink": { "type": "string", "description": "The link to the next page of items", "readOnly": true } - }, - "description": "Paged collection of DeleteImportMachinesJob items" + } }, "PagedExportImportedMachinesJob": { "type": "object", + "description": "Paged collection of ExportImportedMachinesJob items", "properties": { "value": { "type": "array", + "description": "The ExportImportedMachinesJob items on this page", "items": { "$ref": "#/definitions/ExportImportedMachinesJob" }, - "description": "The ExportImportedMachinesJob items on this page", - "x-typespec-name": "ExportImportedMachinesJob[]", - "x-ms-identifiers": [], - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "nextLink": { "type": "string", "description": "The link to the next page of items", "readOnly": true } - }, - "description": "Paged collection of ExportImportedMachinesJob items" + } }, "PagedImportMachinesJob": { "type": "object", + "description": "Paged collection of ImportMachinesJob items", "properties": { "value": { "type": "array", + "description": "The ImportMachinesJob items on this page", "items": { "$ref": "#/definitions/ImportMachinesJob" }, - "description": "The ImportMachinesJob items on this page", - "x-typespec-name": "ImportMachinesJob[]", - "x-ms-identifiers": [], - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "nextLink": { "type": "string", "description": "The link to the next page of items", "readOnly": true } - }, - "description": "Paged collection of ImportMachinesJob items" + } }, "PrivateEndpointConnection": { "type": "object", + "description": "REST model used to encapsulate Private Link properties for tracked resources.", "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionPropertiesV2", @@ -17443,7 +17257,6 @@ ] } }, - "description": "REST model used to encapsulate Private Link properties for tracked resources.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -17452,37 +17265,35 @@ }, "PrivateEndpointConnectionListResult": { "type": "object", + "description": "The response of a PrivateEndpointConnection list operation.", "properties": { "value": { "type": "array", + "description": "The PrivateEndpointConnection items on this page", "items": { "$ref": "#/definitions/PrivateEndpointConnection" - }, - "description": "The PrivateEndpointConnection items on this page", - "x-typespec-name": "PrivateEndpointConnection[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a PrivateEndpointConnection list operation.", "required": [ "value" ] }, "PrivateEndpointConnectionPropertiesV2": { "type": "object", + "description": "PrivateEndpointConnectionProperties V2", "properties": { "groupIds": { "type": "array", + "description": "array of group ids", "items": { "type": "string" }, - "description": "array of group ids", - "x-typespec-name": "string[]", "readOnly": true }, "provisioningState": { @@ -17499,11 +17310,11 @@ "$ref": "#/definitions/PrivateLinkServiceConnectionState", "description": "private endpoints connection state" } - }, - "description": "PrivateEndpointConnectionProperties V2" + } }, "PrivateLinkResource": { "type": "object", + "description": "REST model used to encapsulate Private Link properties for tracked resources.", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", @@ -17515,7 +17326,6 @@ ] } }, - "description": "REST model used to encapsulate Private Link properties for tracked resources.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -17524,45 +17334,42 @@ }, "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" - }, - "description": "The PrivateLinkResource items on this page", - "x-typespec-name": "PrivateLinkResource[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a PrivateLinkResource list operation.", "required": [ "value" ] }, "PrivateLinkResourceProperties": { "type": "object", + "description": "private link resource properties model", "properties": { "requiredMembers": { "type": "array", + "description": "required members", "items": { "type": "string" - }, - "description": "required members", - "x-typespec-name": "string[]" + } }, "requiredZoneNames": { "type": "array", + "description": "required zone names", "items": { "type": "string" - }, - "description": "required zone names", - "x-typespec-name": "string[]" + } }, "groupId": { "type": "string", @@ -17573,11 +17380,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "private link resource properties model" + } }, "PrivateLinkServiceConnectionState": { "type": "object", + "description": "Service Connection State", "properties": { "status": { "$ref": "#/definitions/PrivateLinkServiceConnectionStateStatus", @@ -17591,8 +17398,7 @@ "type": "string", "description": "actions required" } - }, - "description": "Service Connection State" + } }, "PrivateLinkServiceConnectionStateStatus": { "type": "string", @@ -17632,6 +17438,7 @@ }, "ProcessorInfo": { "type": "object", + "description": "Processor Information.", "properties": { "name": { "type": "string", @@ -17647,11 +17454,11 @@ "format": "int32", "description": "Gets or sets the total number of cores in a socket." } - }, - "description": "Processor Information." + } }, "ProductSupportStatus": { "type": "object", + "description": "product support status.", "properties": { "currentVersion": { "type": "string", @@ -17674,8 +17481,7 @@ "$ref": "#/definitions/esuYear", "description": "esu year." } - }, - "description": "product support status." + } }, "ProvisioningState": { "type": "string", @@ -17733,37 +17539,38 @@ }, "ProxySiteRefreshBody": { "type": "object", + "description": "Request body for Proxy site refresh action.", "properties": { "applianceName": { "type": "string", "description": "Gets or sets the appliance name of the agent in the site." } - }, - "description": "Request body for Proxy site refresh action." + } }, "RequestExportMachineErrorsProperties": { "type": "object", + "description": "The Properties class for export machine errors request body.", "properties": { "discoveryScope": { "$ref": "#/definitions/ExportMachineErrorsProperties", "description": "Gets or sets the discovery scope." } - }, - "description": "The Properties class for export machine errors request body." + } }, "ResourceId": { "type": "object", + "description": "PrivateEndpointModelsResourceId", "properties": { "id": { "type": "string", "description": "id name", "readOnly": true } - }, - "description": "PrivateEndpointModelsResourceId" + } }, "RunAsAccountMachineInput": { "type": "object", + "description": "Machine class.", "properties": { "machineId": { "type": "string", @@ -17773,11 +17580,11 @@ "type": "string", "description": "run as AccountId" } - }, - "description": "Machine class." + } }, "RunAsAccountProperties": { "type": "object", + "description": "Class for run as account properties.", "properties": { "displayName": { "type": "string", @@ -17809,8 +17616,7 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for run as account properties." + } }, "SQLDiscoveryScopeStatus": { "type": "string", @@ -17874,6 +17680,7 @@ }, "SasUriResponse": { "type": "object", + "description": "Import URI response class.", "properties": { "jobArmId": { "type": "string", @@ -17883,11 +17690,11 @@ "type": "string", "description": "Gets or sets the SAS URI." } - }, - "description": "Import URI response class." + } }, "Server": { "type": "object", + "description": "A machine resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/ServerProperties", @@ -17899,7 +17706,6 @@ ] } }, - "description": "A machine resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -17908,6 +17714,7 @@ }, "ServerDisk": { "type": "object", + "description": "Server disk details.", "properties": { "id": { "type": "string", @@ -17939,11 +17746,11 @@ "type": "string", "description": "Gets or sets Path of the disk." } - }, - "description": "Server disk details." + } }, "ServerJob": { "type": "object", + "description": "A host resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/JobProperties", @@ -17955,7 +17762,6 @@ ] } }, - "description": "A host resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -17964,52 +17770,49 @@ }, "ServerJobListResult": { "type": "object", + "description": "The response of a ServerJob list operation.", "properties": { "value": { "type": "array", + "description": "The ServerJob items on this page", "items": { "$ref": "#/definitions/ServerJob" - }, - "description": "The ServerJob items on this page", - "x-typespec-name": "ServerJob[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a ServerJob list operation.", "required": [ "value" ] }, "ServerListResult": { "type": "object", + "description": "The response of a Server list operation.", "properties": { "value": { "type": "array", + "description": "The Server items on this page", "items": { "$ref": "#/definitions/Server" - }, - "description": "The Server items on this page", - "x-typespec-name": "Server[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Server list operation.", "required": [ "value" ] }, "ServerNetworkAdapter": { "type": "object", + "description": "Second level object represented in responses as part of Machine REST resource.", "properties": { "nicId": { "type": "string", @@ -18021,11 +17824,10 @@ }, "ipAddressList": { "type": "array", + "description": "Gets IP addresses for the machine.", "items": { "type": "string" }, - "description": "Gets IP addresses for the machine.", - "x-typespec-name": "string[]", "readOnly": true }, "networkName": { @@ -18036,11 +17838,11 @@ "type": "string", "description": "Gets or sets Type of the IP address." } - }, - "description": "Second level object represented in responses as part of Machine REST resource." + } }, "ServerProperties": { "type": "object", + "description": "Server REST resource.", "properties": { "displayName": { "type": "string", @@ -18053,12 +17855,11 @@ }, "networkAdapters": { "type": "array", + "description": "Gets or sets the network adapters of the server.", "items": { "$ref": "#/definitions/ServerNetworkAdapter" }, - "x-ms-identifiers": [], - "description": "Gets or sets the network adapters of the server.", - "x-typespec-name": "ServerNetworkAdapter[]" + "x-ms-identifiers": [] }, "hydratedFqdn": { "type": "string", @@ -18066,11 +17867,10 @@ }, "disks": { "type": "array", + "description": "Gets or sets the disk details of server.", "items": { "$ref": "#/definitions/ServerDisk" - }, - "description": "Gets or sets the disk details of server.", - "x-typespec-name": "ServerDisk[]" + } }, "validationRequired": { "type": "string", @@ -18129,20 +17929,18 @@ }, "applianceNames": { "type": "array", + "description": "Gets the appliance names.", "items": { "type": "string" }, - "description": "Gets the appliance names.", - "x-typespec-name": "string[]", "readOnly": true }, "errors": { "type": "array", + "description": "Errors for machine.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Errors for machine.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "applicationDiscovery": { @@ -18233,11 +18031,10 @@ }, "tags": { "type": "object", + "description": "Gets or sets tags on the Server machine.", "additionalProperties": { "$ref": "#/definitions/Azure.ResourceManager.Object" - }, - "description": "Gets or sets tags on the Server machine.", - "x-typespec-name": "Record" + } }, "updatedTimestamp": { "type": "string", @@ -18248,11 +18045,11 @@ "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the server resource." } - }, - "description": "Server REST resource." + } }, "ServerRunAsAccount": { "type": "object", + "description": "A run as account resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/RunAsAccountProperties", @@ -18264,7 +18061,6 @@ ] } }, - "description": "A run as account resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -18273,29 +18069,28 @@ }, "ServerRunAsAccountListResult": { "type": "object", + "description": "The response of a ServerRunAsAccount list operation.", "properties": { "value": { "type": "array", + "description": "The ServerRunAsAccount items on this page", "items": { "$ref": "#/definitions/ServerRunAsAccount" - }, - "description": "The ServerRunAsAccount items on this page", - "x-typespec-name": "ServerRunAsAccount[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a ServerRunAsAccount list operation.", "required": [ "value" ] }, "ServerSiteResource": { "type": "object", + "description": "A ServerSiteResource", "properties": { "properties": { "$ref": "#/definitions/SitesProperties", @@ -18307,7 +18102,6 @@ ] } }, - "description": "A ServerSiteResource", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -18316,47 +18110,45 @@ }, "ServerSiteResourceListResult": { "type": "object", + "description": "The response of a ServerSiteResource list operation.", "properties": { "value": { "type": "array", + "description": "The ServerSiteResource items on this page", "items": { "$ref": "#/definitions/ServerSiteResource" - }, - "description": "The ServerSiteResource items on this page", - "x-typespec-name": "ServerSiteResource[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a ServerSiteResource list operation.", "required": [ "value" ] }, "ServerSiteResourceUpdate": { "type": "object", + "description": "The type used for update operations of the ServerSiteResource.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } }, "properties": { "$ref": "#/definitions/ServerSiteResourceUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the ServerSiteResource." + } }, "ServerSiteResourceUpdateProperties": { "type": "object", + "description": "The updatable properties of the ServerSiteResource.", "properties": { "servicePrincipalIdentityDetails": { "$ref": "#/definitions/SiteSpnProperties", @@ -18374,11 +18166,11 @@ "type": "string", "description": "Gets or sets the ARM ID of migration hub solution for SDS." } - }, - "description": "The updatable properties of the ServerSiteResource." + } }, "ServerSiteUsage": { "type": "object", + "description": "Server site usage.", "properties": { "runAsAccountCount": { "type": "integer", @@ -18390,11 +18182,11 @@ "format": "int32", "description": "Gets or sets the number of servers part of the site." } - }, - "description": "Server site usage." + } }, "ServerSiteUsageResponse": { "type": "object", + "description": "The properties of ServerSiteUsageResponse.", "properties": { "runAsAccounts": { "type": "integer", @@ -18407,7 +18199,6 @@ "description": "Gets or sets the number of servers part of the site." } }, - "description": "The properties of ServerSiteUsageResponse.", "required": [ "runAsAccounts", "serverCount" @@ -18415,6 +18206,7 @@ }, "ServerSoftwareInventory": { "type": "object", + "description": "An software inventory resource belonging to a server resource.", "properties": { "properties": { "$ref": "#/definitions/MachineSoftwareInventoryProperties", @@ -18426,7 +18218,6 @@ ] } }, - "description": "An software inventory resource belonging to a server resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -18435,39 +18226,38 @@ }, "ServerSoftwareInventoryListResult": { "type": "object", + "description": "The response of a ServerSoftwareInventory list operation.", "properties": { "value": { "type": "array", + "description": "The ServerSoftwareInventory items on this page", "items": { "$ref": "#/definitions/ServerSoftwareInventory" - }, - "description": "The ServerSoftwareInventory items on this page", - "x-typespec-name": "ServerSoftwareInventory[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a ServerSoftwareInventory list operation.", "required": [ "value" ] }, "ServerUpdate": { "type": "object", + "description": "The type used for update operations of the Server.", "properties": { "properties": { "$ref": "#/definitions/ServerUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the Server." + } }, "ServerUpdateProperties": { "type": "object", + "description": "The updatable properties of the Server.", "properties": { "fqdn": { "type": "string", @@ -18475,12 +18265,11 @@ }, "networkAdapters": { "type": "array", + "description": "Gets or sets the network adapters of the server.", "items": { "$ref": "#/definitions/ServerNetworkAdapter" }, - "x-ms-identifiers": [], - "description": "Gets or sets the network adapters of the server.", - "x-typespec-name": "ServerNetworkAdapter[]" + "x-ms-identifiers": [] }, "hydratedFqdn": { "type": "string", @@ -18488,11 +18277,10 @@ }, "disks": { "type": "array", + "description": "Gets or sets the disk details of server.", "items": { "$ref": "#/definitions/ServerDisk" - }, - "description": "Gets or sets the disk details of server.", - "x-typespec-name": "ServerDisk[]" + } }, "validationRequired": { "type": "string", @@ -18534,18 +18322,16 @@ }, "tags": { "type": "object", + "description": "Gets or sets tags on the Server machine.", "additionalProperties": { "$ref": "#/definitions/Azure.ResourceManager.Object" - }, - "description": "Gets or sets tags on the Server machine.", - "x-typespec-name": "Record" + } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state of the server resource." } - }, - "description": "The updatable properties of the Server." + } }, "ShallowDiscoveryStatus": { "type": "string", @@ -18609,6 +18395,7 @@ }, "SharePointServer": { "type": "object", + "description": "SharePointServer in the guest virtual machine.", "properties": { "productName": { "type": "string", @@ -18630,11 +18417,11 @@ "description": "Gets or sets Version of the SharePointServer.", "readOnly": true } - }, - "description": "SharePointServer in the guest virtual machine." + } }, "SiteAgentProperties": { "type": "object", + "description": "Class for site agent properties.", "properties": { "id": { "type": "string", @@ -18660,11 +18447,11 @@ "type": "string", "description": "Gets or sets the key vault ARM Id." } - }, - "description": "Class for site agent properties." + } }, "SiteApplianceProperties": { "type": "object", + "description": "Class for site appliance properties.", "properties": { "servicePrincipalIdentityDetails": { "$ref": "#/definitions/SiteSpnProperties", @@ -18678,11 +18465,11 @@ "type": "string", "description": "Gets or sets the Appliance Name." } - }, - "description": "Class for site appliance properties." + } }, "SiteErrorSummary": { "type": "object", + "description": "Site error summary.", "properties": { "applianceName": { "type": "string", @@ -18697,7 +18484,6 @@ "description": "The link to fetch more models." } }, - "description": "Site error summary.", "required": [ "applianceName", "discoveryScopeErrorSummaries" @@ -18705,6 +18491,7 @@ }, "SiteHealthSummary": { "type": "object", + "description": "The properties of ServerSiteResource.", "properties": { "applianceName": { "type": "string", @@ -18759,36 +18546,33 @@ }, "affectedResources": { "type": "array", + "description": "Gets or sets the affected resources.", "items": { "type": "string" - }, - "description": "Gets or sets the affected resources.", - "x-typespec-name": "string[]" + } }, "fabricLayoutUpdateSources": { "type": "array", + "description": "Gets or sets sources of the exception.", "items": { "$ref": "#/definitions/SiteHealthSummaryFabricLayoutUpdateSourcesItem" - }, - "description": "Gets or sets sources of the exception.", - "x-typespec-name": "SiteHealthSummaryFabricLayoutUpdateSourcesItem[]" + } } - }, - "description": "The properties of ServerSiteResource." + } }, "SiteHealthSummaryCollection": { "type": "object", + "description": "Collection of SiteHealthSummary.", "properties": { "value": { "type": "array", + "description": "Gets the list of SiteHealthSummary.", "items": { "$ref": "#/definitions/SiteHealthSummary" }, "x-ms-identifiers": [ "applianceName" - ], - "description": "Gets the list of SiteHealthSummary.", - "x-typespec-name": "SiteHealthSummary[]" + ] }, "nextLink": { "type": "string", @@ -18796,7 +18580,6 @@ "readOnly": true } }, - "description": "Collection of SiteHealthSummary.", "required": [ "value" ] @@ -18833,6 +18616,7 @@ }, "SiteProperties": { "type": "object", + "description": "The properties of VMwareSiteResource", "properties": { "masterSiteId": { "type": "string", @@ -18864,11 +18648,11 @@ "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "The properties of VMwareSiteResource" + } }, "SiteSpnProperties": { "type": "object", + "description": "Class for site properties.", "properties": { "tenantId": { "type": "string", @@ -18894,11 +18678,11 @@ "type": "string", "description": "Gets or sets the raw certificate data for building certificate expiry flows." } - }, - "description": "Class for site properties." + } }, "SitesProperties": { "type": "object", + "description": "The properties of SiteResource", "properties": { "masterSiteId": { "type": "string", @@ -18931,11 +18715,11 @@ "description": "The status of the last operation.", "readOnly": true } - }, - "description": "The properties of SiteResource" + } }, "SpringBootDiscovery": { "type": "object", + "description": "Data related to a machine's spring boot discovery.", "properties": { "totalInstanceCount": { "type": "integer", @@ -18955,11 +18739,11 @@ "$ref": "#/definitions/DiscoveryScopeStatus", "description": "Gets or sets status of partner discovery." } - }, - "description": "Data related to a machine's spring boot discovery." + } }, "SqlAvailabilityGroup": { "type": "object", + "description": "Class representing the web model of SQL Availability Group.", "properties": { "properties": { "$ref": "#/definitions/SqlAvailabilityGroupProperties", @@ -18971,7 +18755,6 @@ ] } }, - "description": "Class representing the web model of SQL Availability Group.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -18980,29 +18763,28 @@ }, "SqlAvailabilityGroupListResult": { "type": "object", + "description": "The response of a SqlAvailabilityGroup list operation.", "properties": { "value": { "type": "array", + "description": "The SqlAvailabilityGroup items on this page", "items": { "$ref": "#/definitions/SqlAvailabilityGroup" - }, - "description": "The SqlAvailabilityGroup items on this page", - "x-typespec-name": "SqlAvailabilityGroup[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a SqlAvailabilityGroup list operation.", "required": [ "value" ] }, "SqlAvailabilityGroupProperties": { "type": "object", + "description": "Class for SQL Server availability group properties.", "properties": { "availabilityGroupName": { "type": "string", @@ -19022,23 +18804,21 @@ }, "availabilityReplicas": { "type": "array", + "description": "Gets the list of availability replica properties which together forms this availability group.", "items": { "$ref": "#/definitions/SqlAvailabilityReplicaProperties" }, - "x-ms-identifiers": [], - "description": "Gets the list of availability replica properties which together forms this availability group.", - "x-typespec-name": "SqlAvailabilityReplicaProperties[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "parentReplicaOverviewList": { "type": "array", + "description": "Gets the parent availability replica overview if any.\n This would be\nset with details of parent AG and AR for cases where this availability group is\na part of a distributed AG.\n Currently, we do not populate this\nsince discovery and linking of DAG(Distributed Availability Group) is not\nimplemented.", "items": { "$ref": "#/definitions/SqlAvailabilityReplicaOverview" }, - "x-ms-identifiers": [], - "description": "Gets the parent availability replica overview if any.\n This would be\nset with details of parent AG and AR for cases where this availability group is\na part of a distributed AG.\n Currently, we do not populate this\nsince discovery and linking of DAG(Distributed Availability Group) is not\nimplemented.", - "x-typespec-name": "SqlAvailabilityReplicaOverview[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "isPartOfDistributedAvailabilityGroup": { "type": "boolean", @@ -19061,8 +18841,7 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for SQL Server availability group properties." + } }, "SqlAvailabilityGroupPropertiesAvailabilityGroupType": { "type": "string", @@ -19096,6 +18875,7 @@ }, "SqlAvailabilityGroupReplicaInfo": { "type": "object", + "description": "Class which represents the SQL availability replica properties of type AG.", "properties": { "clusterName": { "type": "string", @@ -19109,8 +18889,7 @@ "type": "string", "description": "Gets or sets the AG ARM ID which are part of this Replica." } - }, - "description": "Class which represents the SQL availability replica properties of type AG." + } }, "SqlAvailabilityGroupSqlAvailabilityReplicaPropertiesReplicaCommitMode": { "type": "string", @@ -19300,6 +19079,7 @@ }, "SqlAvailabilityReplicaOverview": { "type": "object", + "description": "Web model for SQL replica overview.", "properties": { "replicaState": { "$ref": "#/definitions/SqlAvailabilityReplicaOverviewReplicaState", @@ -19317,8 +19097,7 @@ "type": "string", "description": "Gets or sets the SQL Availability group name." } - }, - "description": "Web model for SQL replica overview." + } }, "SqlAvailabilityReplicaOverviewReplicaState": { "type": "string", @@ -19352,6 +19131,7 @@ }, "SqlAvailabilityReplicaProperties": { "type": "object", + "description": "Class for SQL Server availability replica properties.", "properties": { "availabilityReplicaName": { "type": "string", @@ -19393,11 +19173,11 @@ "$ref": "#/definitions/SqlAvailabilityGroupReplicaInfo", "description": "Gets or sets the Availability Replica object if Replica is of type AG. This is\nnull in case Replica is\n of type database. This is to be populated\nin case AG is of type DAG." } - }, - "description": "Class for SQL Server availability replica properties." + } }, "SqlDatabasePropertiesV2": { "type": "object", + "description": "Class for SQL Server database properties.", "properties": { "parentReplicaOverview": { "$ref": "#/definitions/SqlAvailabilityReplicaOverview", @@ -19409,13 +19189,12 @@ }, "fileMetadataList": { "type": "array", + "description": "Gets the file metadata list.", "items": { "$ref": "#/definitions/FileMetaData" }, - "x-ms-identifiers": [], - "description": "Gets the file metadata list.", - "x-typespec-name": "FileMetaData[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "hostname": { "type": "string", @@ -19452,11 +19231,10 @@ }, "errors": { "type": "array", + "description": "Gets the errors.", "items": { "$ref": "#/definitions/Errors" }, - "description": "Gets the errors.", - "x-typespec-name": "Errors[]", "readOnly": true }, "createdTimestamp": { @@ -19471,11 +19249,11 @@ "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "Class for SQL Server database properties." + } }, "SqlDatabaseReplicaInfo": { "type": "object", + "description": "Class which represents the SQL availability replica properties of type\ndatabases.", "properties": { "hostName": { "type": "string", @@ -19489,11 +19267,11 @@ "type": "string", "description": "Gets or sets the SQL Server name of the availability replica." } - }, - "description": "Class which represents the SQL availability replica properties of type\ndatabases." + } }, "SqlDatabaseV2": { "type": "object", + "description": "Class representing the web model of SQL Database.", "properties": { "properties": { "$ref": "#/definitions/SqlDatabasePropertiesV2", @@ -19505,7 +19283,6 @@ ] } }, - "description": "Class representing the web model of SQL Database.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -19514,29 +19291,28 @@ }, "SqlDatabaseV2ListResult": { "type": "object", + "description": "The response of a SqlDatabaseV2 list operation.", "properties": { "value": { "type": "array", + "description": "The SqlDatabaseV2 items on this page", "items": { "$ref": "#/definitions/SqlDatabaseV2" - }, - "description": "The SqlDatabaseV2 items on this page", - "x-typespec-name": "SqlDatabaseV2[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a SqlDatabaseV2 list operation.", "required": [ "value" ] }, "SqlDiscovery": { "type": "object", + "description": "Contains data related SQL discovery.", "properties": { "successfullyDiscoveredServerCount": { "type": "integer", @@ -19560,11 +19336,11 @@ "$ref": "#/definitions/SQLDiscoveryScopeStatus", "description": "discovery Scope Status" } - }, - "description": "Contains data related SQL discovery." + } }, "SqlDiscoverySiteDataSource": { "type": "object", + "description": "A SQL discovery site data source resource.", "properties": { "properties": { "$ref": "#/definitions/SqlDiscoverySiteDataSourceProperties", @@ -19576,7 +19352,6 @@ ] } }, - "description": "A SQL discovery site data source resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -19585,29 +19360,28 @@ }, "SqlDiscoverySiteDataSourceListResult": { "type": "object", + "description": "The response of a SqlDiscoverySiteDataSource list operation.", "properties": { "value": { "type": "array", + "description": "The SqlDiscoverySiteDataSource items on this page", "items": { "$ref": "#/definitions/SqlDiscoverySiteDataSource" - }, - "description": "The SqlDiscoverySiteDataSource items on this page", - "x-typespec-name": "SqlDiscoverySiteDataSource[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a SqlDiscoverySiteDataSource list operation.", "required": [ "value" ] }, "SqlDiscoverySiteDataSourceProperties": { "type": "object", + "description": "Discovery site data source properties class.", "properties": { "discoverySiteId": { "type": "string", @@ -19618,11 +19392,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Discovery site data source properties class." + } }, "SqlFciProperties": { "type": "object", + "description": "The class representing the properties for an FCI instance.", "properties": { "state": { "$ref": "#/definitions/FCIInstanceState", @@ -19641,11 +19415,11 @@ "format": "int32", "description": "Gets or sets the count of Shared Disks for SQL FCI." } - }, - "description": "The class representing the properties for an FCI instance." + } }, "SqlJob": { "type": "object", + "description": "Class representing the web model of SQL Database.", "properties": { "properties": { "$ref": "#/definitions/JobProperties", @@ -19657,7 +19431,6 @@ ] } }, - "description": "Class representing the web model of SQL Database.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -19666,29 +19439,28 @@ }, "SqlJobListResult": { "type": "object", + "description": "The response of a SqlJob list operation.", "properties": { "value": { "type": "array", + "description": "The SqlJob items on this page", "items": { "$ref": "#/definitions/SqlJob" - }, - "description": "The SqlJob items on this page", - "x-typespec-name": "SqlJob[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a SqlJob list operation.", "required": [ "value" ] }, "SqlMachineOverview": { "type": "object", + "description": "Gets or sets SQL machine overview data.", "properties": { "machineArmId": { "type": "string", @@ -19702,8 +19474,7 @@ "$ref": "#/definitions/SqlMachineOverviewFciRole", "description": "Gets or sets SQL machine FCI role." } - }, - "description": "Gets or sets SQL machine overview data." + } }, "SqlMachineOverviewFciRole": { "type": "string", @@ -19791,6 +19562,7 @@ }, "SqlRunAsAccount": { "type": "object", + "description": "A runasaccount resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/RunAsAccountProperties", @@ -19802,7 +19574,6 @@ ] } }, - "description": "A runasaccount resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -19811,29 +19582,28 @@ }, "SqlRunAsAccountListResult": { "type": "object", + "description": "The response of a SqlRunAsAccount list operation.", "properties": { "value": { "type": "array", + "description": "The SqlRunAsAccount items on this page", "items": { "$ref": "#/definitions/SqlRunAsAccount" - }, - "description": "The SqlRunAsAccount items on this page", - "x-typespec-name": "SqlRunAsAccount[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a SqlRunAsAccount list operation.", "required": [ "value" ] }, "SqlServerApplication": { "type": "object", + "description": "SQLServer in the guest virtual machine.", "properties": { "name": { "type": "string", @@ -19900,21 +19670,20 @@ "description": "Gets the status.", "readOnly": true } - }, - "description": "SQLServer in the guest virtual machine." + } }, "SqlServerProperties": { "type": "object", + "description": "Class for SQL Server properties.", "properties": { "machineOverviewList": { "type": "array", + "description": "Gets the Machine Overview properties of all machines on which the SQL server is deployed.", "items": { "$ref": "#/definitions/SqlMachineOverview" }, - "x-ms-identifiers": [], - "description": "Gets the Machine Overview properties of all machines on which the SQL server is deployed.", - "x-typespec-name": "SqlMachineOverview[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "numberOfAgDatabases": { "type": "integer", @@ -20001,11 +19770,10 @@ }, "machineArmIds": { "type": "array", + "description": "Gets the list of machine ARM Ids on which the SQL server is deployed.", "items": { "type": "string" }, - "description": "Gets the list of machine ARM Ids on which the SQL server is deployed.", - "x-typespec-name": "string[]", "readOnly": true }, "runAsAccountId": { @@ -20031,20 +19799,18 @@ }, "errors": { "type": "array", + "description": "Gets the errors.", "items": { "$ref": "#/definitions/Errors" }, - "description": "Gets the errors.", - "x-typespec-name": "Errors[]", "readOnly": true }, "tags": { "type": "object", + "description": "Gets or sets tags on the resource.", "additionalProperties": { "$ref": "#/definitions/Azure.ResourceManager.Object" - }, - "description": "Gets or sets tags on the resource.", - "x-typespec-name": "Record" + } }, "isDeleted": { "type": "boolean", @@ -20066,8 +19832,7 @@ "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "Class for SQL Server properties." + } }, "SqlServerStatus": { "type": "string", @@ -20131,6 +19896,7 @@ }, "SqlServerV2": { "type": "object", + "description": "Class representing the web model of SQL Server.", "properties": { "properties": { "$ref": "#/definitions/SqlServerProperties", @@ -20142,7 +19908,6 @@ ] } }, - "description": "Class representing the web model of SQL Server.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -20151,39 +19916,38 @@ }, "SqlServerV2ListResult": { "type": "object", + "description": "The response of a SqlServerV2 list operation.", "properties": { "value": { "type": "array", + "description": "The SqlServerV2 items on this page", "items": { "$ref": "#/definitions/SqlServerV2" - }, - "description": "The SqlServerV2 items on this page", - "x-typespec-name": "SqlServerV2[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a SqlServerV2 list operation.", "required": [ "value" ] }, "SqlServerV2Update": { "type": "object", + "description": "The type used for update operations of the SqlServerV2.", "properties": { "properties": { "$ref": "#/definitions/SqlServerV2UpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the SqlServerV2." + } }, "SqlServerV2UpdateProperties": { "type": "object", + "description": "The updatable properties of the SqlServerV2.", "properties": { "numberOfAgDatabases": { "type": "integer", @@ -20291,11 +20055,10 @@ }, "tags": { "type": "object", + "description": "Gets or sets tags on the resource.", "additionalProperties": { "$ref": "#/definitions/Azure.ResourceManager.Object" - }, - "description": "Gets or sets tags on the resource.", - "x-typespec-name": "Record" + } }, "isDeleted": { "type": "boolean", @@ -20317,11 +20080,11 @@ "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "The updatable properties of the SqlServerV2." + } }, "SqlSite": { "type": "object", + "description": "SQL site web model.", "properties": { "properties": { "$ref": "#/definitions/SqlSiteProperties", @@ -20333,7 +20096,6 @@ ] } }, - "description": "SQL site web model.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -20342,38 +20104,36 @@ }, "SqlSiteListResult": { "type": "object", + "description": "The response of a SqlSite list operation.", "properties": { "value": { "type": "array", + "description": "The SqlSite items on this page", "items": { "$ref": "#/definitions/SqlSite" - }, - "description": "The SqlSite items on this page", - "x-typespec-name": "SqlSite[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a SqlSite list operation.", "required": [ "value" ] }, "SqlSiteProperties": { "type": "object", + "description": "Class for SQL site properties.", "properties": { "siteAppliancePropertiesCollection": { "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", "items": { "$ref": "#/definitions/SiteApplianceProperties" }, - "x-ms-identifiers": [], - "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", - "x-typespec-name": "SiteApplianceProperties[]" + "x-ms-identifiers": [] }, "discoveryScenario": { "$ref": "#/definitions/SqlSitePropertiesDiscoveryScenario", @@ -20389,8 +20149,7 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for SQL site properties." + } }, "SqlSitePropertiesDiscoveryScenario": { "type": "string", @@ -20418,45 +20177,45 @@ }, "SqlSiteRefreshBody": { "type": "object", + "description": "SQL site refresh.", "properties": { "applianceName": { "type": "string", "description": "Gets or sets the appliance name of the agent in the site." } - }, - "description": "SQL site refresh." + } }, "SqlSiteUpdate": { "type": "object", + "description": "The type used for update operations of the SqlSite.", "properties": { "properties": { "$ref": "#/definitions/SqlSiteUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the SqlSite." + } }, "SqlSiteUpdateProperties": { "type": "object", + "description": "The updatable properties of the SqlSite.", "properties": { "siteAppliancePropertiesCollection": { "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", "items": { "$ref": "#/definitions/SiteApplianceProperties" }, - "x-ms-identifiers": [], - "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", - "x-typespec-name": "SiteApplianceProperties[]" + "x-ms-identifiers": [] }, "discoveryScenario": { "$ref": "#/definitions/SqlSitePropertiesDiscoveryScenario", "description": "Gets or sets the discovery scenario." } - }, - "description": "The updatable properties of the SqlSite." + } }, "SqlSiteUsage": { "type": "object", + "description": "SQL site usage.", "properties": { "serverCount": { "type": "integer", @@ -20473,11 +20232,11 @@ "format": "int32", "description": "Gets or sets the number of run as accounts in the site." } - }, - "description": "SQL site usage." + } }, "StaticDiscovery": { "type": "object", + "description": "Contains data related static data discovery scope.", "properties": { "discoveryScopeStatus": { "$ref": "#/definitions/StaticDiscoveryScopeStatus", @@ -20486,11 +20245,10 @@ }, "errors": { "type": "array", + "description": "Gets errors for discovery scope.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets errors for discovery scope.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "hydratedRunAsAccountId": { @@ -20498,8 +20256,7 @@ "description": "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials.", "readOnly": true } - }, - "description": "Contains data related static data discovery scope." + } }, "StaticDiscoveryScopeStatus": { "type": "string", @@ -20563,6 +20320,7 @@ }, "SystemCenter": { "type": "object", + "description": "SystemCenter in the guest virtual machine.", "properties": { "productName": { "type": "string", @@ -20579,11 +20337,11 @@ "description": "Gets or sets Version of the SystemCenter.", "readOnly": true } - }, - "description": "SystemCenter in the guest virtual machine." + } }, "TagsMachineInput": { "type": "object", + "description": "Machine class.", "properties": { "machineId": { "type": "string", @@ -20591,17 +20349,16 @@ }, "tags": { "type": "object", + "description": "run as AccountId", "additionalProperties": { "type": "string" - }, - "description": "run as AccountId", - "x-typespec-name": "Record" + } } - }, - "description": "Machine class." + } }, "TomcatEngineUnit": { "type": "object", + "description": "Tomcat engine data.", "properties": { "name": { "type": "string", @@ -20609,18 +20366,17 @@ }, "hosts": { "type": "array", + "description": "Gets or sets the hosts defined for the engine.", "items": { "$ref": "#/definitions/TomcatHostUnit" }, - "x-ms-identifiers": [], - "description": "Gets or sets the hosts defined for the engine.", - "x-typespec-name": "TomcatHostUnit[]" + "x-ms-identifiers": [] } - }, - "description": "Tomcat engine data." + } }, "TomcatHostUnit": { "type": "object", + "description": "Tomcat host data.", "properties": { "name": { "type": "string", @@ -20634,11 +20390,11 @@ "type": "string", "description": "Gets or sets the app base value configured for the host." } - }, - "description": "Tomcat host data." + } }, "TomcatServiceUnit": { "type": "object", + "description": "Tomcat service data.", "properties": { "name": { "type": "string", @@ -20646,22 +20402,21 @@ }, "connectors": { "type": "array", + "description": "Gets or sets the connectors defined for the service component.", "items": { "$ref": "#/definitions/ConnectorUnit" }, - "x-ms-identifiers": [], - "description": "Gets or sets the connectors defined for the service component.", - "x-typespec-name": "ConnectorUnit[]" + "x-ms-identifiers": [] }, "engine": { "$ref": "#/definitions/TomcatEngineUnit", "description": "Gets or sets the engine defined for the service component." } - }, - "description": "Tomcat service data." + } }, "TomcatWebApplicationProperties": { "type": "object", + "description": "Class for web application properties.", "properties": { "hasDatabaseDependency": { "type": "boolean", @@ -20683,6 +20438,14 @@ "description": "Gets the web server name.", "readOnly": true }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the web application is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, "virtualPath": { "type": "string", "description": "Gets the virtual path of the application.", @@ -20695,41 +20458,37 @@ }, "bindings": { "type": "array", + "description": "Gets the front end bindings for the application.", "items": { "$ref": "#/definitions/FrontEndBinding" }, - "x-ms-identifiers": [], - "description": "Gets the front end bindings for the application.", - "x-typespec-name": "FrontEndBinding[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "frameworks": { "type": "array", + "description": "Gets the Error details.", "items": { "$ref": "#/definitions/WebApplicationFramework" }, - "x-ms-identifiers": [], - "description": "Gets the Error details.", - "x-typespec-name": "WebApplicationFramework[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "configurations": { "type": "array", + "description": "Gets the configuration.", "items": { "$ref": "#/definitions/WebApplicationConfigurationUnit" }, - "x-ms-identifiers": [], - "description": "Gets the configuration.", - "x-typespec-name": "WebApplicationConfigurationUnit[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "directories": { "type": "array", + "description": "Gets the directories.", "items": { "$ref": "#/definitions/WebApplicationDirectoryUnit" }, - "description": "Gets the directories.", - "x-typespec-name": "WebApplicationDirectoryUnit[]", "readOnly": true }, "displayName": { @@ -20739,20 +20498,18 @@ }, "tags": { "type": "object", + "description": "Gets tags that can be used with ODATA.", "additionalProperties": { "type": "string" }, - "description": "Gets tags that can be used with ODATA.", - "x-typespec-name": "Record", "readOnly": true }, "staticFolders": { "type": "array", + "description": "Static folders.", "items": { "type": "string" }, - "description": "Static folders.", - "x-typespec-name": "string[]", "readOnly": true }, "machineDisplayName": { @@ -20782,20 +20539,18 @@ }, "errors": { "type": "array", + "description": "Gets the Error details.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets the Error details.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "applianceNames": { "type": "array", + "description": "Gets the appliance names.", "items": { "type": "string" }, - "description": "Gets the appliance names.", - "x-typespec-name": "string[]", "readOnly": true }, "hasErrors": { @@ -20808,11 +20563,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for web application properties." + } }, "TomcatWebApplications": { "type": "object", + "description": "Web application REST Resource.", "properties": { "properties": { "$ref": "#/definitions/TomcatWebApplicationProperties", @@ -20824,7 +20579,6 @@ ] } }, - "description": "Web application REST Resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -20833,43 +20587,40 @@ }, "TomcatWebApplicationsListResult": { "type": "object", + "description": "The response of a TomcatWebApplications list operation.", "properties": { "value": { "type": "array", + "description": "The TomcatWebApplications items on this page", "items": { "$ref": "#/definitions/TomcatWebApplications" - }, - "description": "The TomcatWebApplications items on this page", - "x-typespec-name": "TomcatWebApplications[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a TomcatWebApplications list operation.", "required": [ "value" ] }, "TomcatWebApplicationsUpdate": { "type": "object", - "properties": {}, "description": "The type used for update operations of the TomcatWebApplications." }, "TomcatWebServerProperties": { "type": "object", + "description": "Class for web server properties.", "properties": { "services": { "type": "array", + "description": "Gets or sets the services defined in the server.", "items": { "$ref": "#/definitions/TomcatServiceUnit" }, - "x-ms-identifiers": [], - "description": "Gets or sets the services defined in the server.", - "x-typespec-name": "TomcatServiceUnit[]" + "x-ms-identifiers": [] }, "catalinaHome": { "type": "string", @@ -20922,20 +20673,18 @@ }, "machineIds": { "type": "array", + "description": "Gets the list of machines.", "items": { "type": "string" }, - "description": "Gets the list of machines.", - "x-typespec-name": "string[]", "readOnly": true }, "webApplications": { "type": "array", + "description": "Gets the list of web applications.", "items": { "type": "string" }, - "description": "Gets the list of web applications.", - "x-typespec-name": "string[]", "readOnly": true }, "displayName": { @@ -20979,20 +20728,18 @@ }, "errors": { "type": "array", + "description": "Gets the Error details.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets the Error details.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "applianceNames": { "type": "array", + "description": "Gets the appliance names.", "items": { "type": "string" }, - "description": "Gets the appliance names.", - "x-typespec-name": "string[]", "readOnly": true }, "hasErrors": { @@ -21005,11 +20752,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for web server properties." + } }, "TomcatWebServers": { "type": "object", + "description": "Web server REST Resource.", "properties": { "properties": { "$ref": "#/definitions/TomcatWebServerProperties", @@ -21021,7 +20768,6 @@ ] } }, - "description": "Web server REST Resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -21030,74 +20776,70 @@ }, "TomcatWebServersListResult": { "type": "object", + "description": "The response of a TomcatWebServers list operation.", "properties": { "value": { "type": "array", + "description": "The TomcatWebServers items on this page", "items": { "$ref": "#/definitions/TomcatWebServers" - }, - "description": "The TomcatWebServers items on this page", - "x-typespec-name": "TomcatWebServers[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a TomcatWebServers list operation.", "required": [ "value" ] }, "UpdateMachineDepMapStatus": { "type": "object", + "description": "Defines class that represents input to enable or disable DMP on machine\n \n for cosmos entity operation.", "properties": { "machines": { "type": "array", + "description": "Gets or sets the machine collection.", "items": { "$ref": "#/definitions/DependencyMapMachineInput" }, - "x-ms-identifiers": [], - "description": "Gets or sets the machine collection.", - "x-typespec-name": "DependencyMapMachineInput[]" + "x-ms-identifiers": [] } - }, - "description": "Defines class that represents input to enable or disable DMP on machine\n \n for cosmos entity operation." + } }, "UpdateMachineRunAsAccount": { "type": "object", + "description": "Defines class that represents input to update RunAsAccount on machine\n \n for cosmos entity operation.", "properties": { "machines": { "type": "array", + "description": "Gets or sets the machine collection.", "items": { "$ref": "#/definitions/RunAsAccountMachineInput" }, - "x-ms-identifiers": [], - "description": "Gets or sets the machine collection.", - "x-typespec-name": "RunAsAccountMachineInput[]" + "x-ms-identifiers": [] } - }, - "description": "Defines class that represents input to update RunAsAccount on machine\n \n for cosmos entity operation." + } }, "UpdateMachineTags": { "type": "object", + "description": "Defines class that represents input to update Tags on machine\n \n for cosmos entity operation.", "properties": { "machines": { "type": "array", + "description": "Gets or sets the machine collection.", "items": { "$ref": "#/definitions/TagsMachineInput" }, - "x-ms-identifiers": [], - "description": "Gets or sets the machine collection.", - "x-typespec-name": "TagsMachineInput[]" + "x-ms-identifiers": [] } - }, - "description": "Defines class that represents input to update Tags on machine\n \n for cosmos entity operation." + } }, "V20180501PreviewVmwareRunAsAccount": { "type": "object", + "description": "Run as account REST Resource.", "properties": { "id": { "type": "string", @@ -21119,27 +20861,25 @@ "description": "Gets nested properties.", "readOnly": true } - }, - "description": "Run as account REST Resource." + } }, "V20180501PreviewVmwareRunAsAccountVmwareRunAsAccountCollection": { "type": "object", + "description": "Collection of VMware run as accounts.", "properties": { "value": { "type": "array", + "description": "Gets the list of run as accounts.", "items": { "$ref": "#/definitions/V20180501PreviewVmwareRunAsAccount" - }, - "description": "Gets the list of run as accounts.", - "x-typespec-name": "V20180501PreviewVmwareRunAsAccount[]" + } }, "nextLink": { "type": "string", "description": "Gets the value of next link.", "readOnly": true } - }, - "description": "Collection of VMware run as accounts." + } }, "VMwareDatastoreType": { "type": "string", @@ -21209,6 +20949,7 @@ }, "Vcenter": { "type": "object", + "description": "A vcenter resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/VcenterProperties", @@ -21220,7 +20961,6 @@ ] } }, - "description": "A vcenter resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -21229,29 +20969,28 @@ }, "VcenterListResult": { "type": "object", + "description": "The response of a Vcenter list operation.", "properties": { "value": { "type": "array", + "description": "The Vcenter items on this page", "items": { "$ref": "#/definitions/Vcenter" - }, - "description": "The Vcenter items on this page", - "x-typespec-name": "Vcenter[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a Vcenter list operation.", "required": [ "value" ] }, "VcenterProperties": { "type": "object", + "description": "The properties of VMwareSiteResource", "properties": { "runAsAccountId": { "type": "string", @@ -21259,11 +20998,10 @@ }, "errors": { "type": "array", + "description": "Gets the errors.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets the errors.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "createdTimestamp": { @@ -21307,8 +21045,7 @@ "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "The properties of VMwareSiteResource" + } }, "Versions": { "type": "string", @@ -21390,6 +21127,7 @@ }, "VmwareDatastore": { "type": "object", + "description": "Second level object returned as part of VMware host REST resource.", "properties": { "uuid": { "type": "string", @@ -21418,11 +21156,11 @@ "description": "Symbolic name of the data store.", "readOnly": true } - }, - "description": "Second level object returned as part of VMware host REST resource." + } }, "VmwareDisk": { "type": "object", + "description": "Second level object returned as part of Machine REST resource.", "properties": { "uuid": { "type": "string", @@ -21476,11 +21214,11 @@ "type": "string", "description": "Gets or sets Path of the disk." } - }, - "description": "Second level object returned as part of Machine REST resource." + } }, "VmwareHost": { "type": "object", + "description": "A host resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/VmwareHostProperties", @@ -21492,7 +21230,6 @@ ] } }, - "description": "A host resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -21501,29 +21238,28 @@ }, "VmwareHostListResult": { "type": "object", + "description": "The response of a VmwareHost list operation.", "properties": { "value": { "type": "array", + "description": "The VmwareHost items on this page", "items": { "$ref": "#/definitions/VmwareHost" - }, - "description": "The VmwareHost items on this page", - "x-typespec-name": "VmwareHost[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a VmwareHost list operation.", "required": [ "value" ] }, "VmwareHostProperties": { "type": "object", + "description": "Class for host properties.", "properties": { "createdTimestamp": { "type": "string", @@ -21537,13 +21273,12 @@ }, "datastores": { "type": "array", + "description": "Gets the data stores.", "items": { "$ref": "#/definitions/VmwareDatastore" }, - "x-ms-identifiers": [], - "description": "Gets the data stores.", - "x-typespec-name": "VmwareDatastore[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "vcenterId": { "type": "string", @@ -21557,11 +21292,10 @@ }, "applianceNames": { "type": "array", + "description": "Gets the appliance names.", "items": { "type": "string" }, - "description": "Gets the appliance names.", - "x-typespec-name": "string[]", "readOnly": true }, "provisioningState": { @@ -21569,11 +21303,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for host properties." + } }, "VmwareJob": { "type": "object", + "description": "A host resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/JobProperties", @@ -21585,7 +21319,6 @@ ] } }, - "description": "A host resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -21594,29 +21327,28 @@ }, "VmwareJobListResult": { "type": "object", + "description": "The response of a VmwareJob list operation.", "properties": { "value": { "type": "array", + "description": "The VmwareJob items on this page", "items": { "$ref": "#/definitions/VmwareJob" - }, - "description": "The VmwareJob items on this page", - "x-typespec-name": "VmwareJob[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a VmwareJob list operation.", "required": [ "value" ] }, "VmwareMachineProperties": { "type": "object", + "description": "Class for machine properties.", "properties": { "vCenterFqdn": { "type": "string", @@ -21645,13 +21377,12 @@ }, "disks": { "type": "array", + "description": "Disks attached to the machine.", "items": { "$ref": "#/definitions/VmwareDisk" }, - "x-ms-identifiers": [], - "description": "Disks attached to the machine.", - "x-typespec-name": "VmwareDisk[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "hostInMaintenanceMode": { "type": "boolean", @@ -21675,13 +21406,12 @@ }, "networkAdapters": { "type": "array", + "description": "Network adapters attached to the machine.", "items": { "$ref": "#/definitions/VmwareNetworkAdapter" }, - "x-ms-identifiers": [], - "description": "Network adapters attached to the machine.", - "x-typespec-name": "VmwareNetworkAdapter[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "vMwareToolsStatus": { "type": "string", @@ -21788,20 +21518,18 @@ }, "applianceNames": { "type": "array", + "description": "Gets the appliance names.", "items": { "type": "string" }, - "description": "Gets the appliance names.", - "x-typespec-name": "string[]", "readOnly": true }, "errors": { "type": "array", + "description": "Errors for machine.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Errors for machine.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "applicationDiscovery": { @@ -21897,11 +21625,10 @@ }, "tags": { "type": "object", + "description": "Gets or sets tags on the VMware machine.", "additionalProperties": { "type": "string" - }, - "description": "Gets or sets tags on the VMware machine.", - "x-typespec-name": "Record" + } }, "updatedTimestamp": { "type": "string", @@ -21913,11 +21640,11 @@ "description": "The status of the last operation.", "readOnly": true } - }, - "description": "Class for machine properties." + } }, "VmwareMachineSoftwareInventory": { "type": "object", + "description": "An software inventory resource belonging to a machine resource.", "properties": { "properties": { "$ref": "#/definitions/MachineSoftwareInventoryProperties", @@ -21929,7 +21656,6 @@ ] } }, - "description": "An software inventory resource belonging to a machine resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -21938,29 +21664,28 @@ }, "VmwareMachineSoftwareInventoryListResult": { "type": "object", + "description": "The response of a VmwareMachineSoftwareInventory list operation.", "properties": { "value": { "type": "array", + "description": "The VmwareMachineSoftwareInventory items on this page", "items": { "$ref": "#/definitions/VmwareMachineSoftwareInventory" - }, - "description": "The VmwareMachineSoftwareInventory items on this page", - "x-typespec-name": "VmwareMachineSoftwareInventory[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a VmwareMachineSoftwareInventory list operation.", "required": [ "value" ] }, "VmwareNetworkAdapter": { "type": "object", + "description": "Second level object represented in responses as part of Machine REST resource.", "properties": { "label": { "type": "string", @@ -21982,11 +21707,10 @@ }, "ipAddressList": { "type": "array", + "description": "Gets IP addresses for the machine.", "items": { "type": "string" }, - "description": "Gets IP addresses for the machine.", - "x-typespec-name": "string[]", "readOnly": true }, "networkName": { @@ -21997,11 +21721,11 @@ "type": "string", "description": "Gets or sets Type of the IP address." } - }, - "description": "Second level object represented in responses as part of Machine REST resource." + } }, "VmwareRunAsAccountResource": { "type": "object", + "description": "A runasaccount resource belonging to a site resource.", "properties": { "properties": { "$ref": "#/definitions/RunAsAccountProperties", @@ -22013,7 +21737,6 @@ ] } }, - "description": "A runasaccount resource belonging to a site resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -22022,29 +21745,28 @@ }, "VmwareRunAsAccountResourceListResult": { "type": "object", + "description": "The response of a VmwareRunAsAccountResource list operation.", "properties": { "value": { "type": "array", + "description": "The VmwareRunAsAccountResource items on this page", "items": { "$ref": "#/definitions/VmwareRunAsAccountResource" - }, - "description": "The VmwareRunAsAccountResource items on this page", - "x-typespec-name": "VmwareRunAsAccountResource[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a VmwareRunAsAccountResource list operation.", "required": [ "value" ] }, "VmwareSite": { "type": "object", + "description": "A VmwareSite", "properties": { "properties": { "$ref": "#/definitions/SitesProperties", @@ -22061,7 +21783,6 @@ "readOnly": true } }, - "description": "A VmwareSite", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" @@ -22070,47 +21791,45 @@ }, "VmwareSiteListResult": { "type": "object", + "description": "The response of a VmwareSite list operation.", "properties": { "value": { "type": "array", + "description": "The VmwareSite items on this page", "items": { "$ref": "#/definitions/VmwareSite" - }, - "description": "The VmwareSite items on this page", - "x-typespec-name": "VmwareSite[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a VmwareSite list operation.", "required": [ "value" ] }, "VmwareSiteUpdate": { "type": "object", + "description": "The type used for update operations of the VmwareSite.", "properties": { "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "description": "Resource tags.", - "x-typespec-name": "Record" + } }, "properties": { "$ref": "#/definitions/VmwareSiteUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the VmwareSite." + } }, "VmwareSiteUpdateProperties": { "type": "object", + "description": "The updatable properties of the VmwareSite.", "properties": { "servicePrincipalIdentityDetails": { "$ref": "#/definitions/SiteSpnProperties", @@ -22132,11 +21851,11 @@ "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation." } - }, - "description": "The updatable properties of the VmwareSite." + } }, "VmwareSiteUsage": { "type": "object", + "description": "VMware site usage.", "properties": { "machineCount": { "type": "integer", @@ -22153,11 +21872,11 @@ "format": "int32", "description": "Gets or sets the number of vCenters part of the site." } - }, - "description": "VMware site usage." + } }, "WebAppDiscovery": { "type": "object", + "description": "Data related to a machine's WebApps discovery.", "properties": { "totalWebServerCount": { "type": "integer", @@ -22173,11 +21892,11 @@ "$ref": "#/definitions/DiscoveryScopeStatus", "description": "Gets or sets status of partner discovery." } - }, - "description": "Data related to a machine's WebApps discovery." + } }, "WebAppExtendedMachine": { "type": "object", + "description": "Web app extended machine REST Resource.", "properties": { "properties": { "$ref": "#/definitions/WebAppExtendedMachineProperties", @@ -22189,7 +21908,6 @@ ] } }, - "description": "Web app extended machine REST Resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -22198,29 +21916,28 @@ }, "WebAppExtendedMachineListResult": { "type": "object", + "description": "The response of a WebAppExtendedMachine list operation.", "properties": { "value": { "type": "array", + "description": "The WebAppExtendedMachine items on this page", "items": { "$ref": "#/definitions/WebAppExtendedMachine" - }, - "description": "The WebAppExtendedMachine items on this page", - "x-typespec-name": "WebAppExtendedMachine[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a WebAppExtendedMachine list operation.", "required": [ "value" ] }, "WebAppExtendedMachineProperties": { "type": "object", + "description": "Class for web extended machine properties.", "properties": { "isDeleted": { "type": "boolean", @@ -22239,11 +21956,10 @@ }, "errors": { "type": "array", + "description": "Gets the Error details.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets the Error details.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "hostName": { @@ -22276,11 +21992,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for web extended machine properties." + } }, "WebAppProperties": { "type": "object", + "description": "Class representing web app properties web model.", "properties": { "webAppArmId": { "type": "string", @@ -22288,32 +22004,30 @@ }, "tags": { "type": "object", + "description": "Gets or sets Tags.", "additionalProperties": { "type": "string" - }, - "description": "Gets or sets Tags.", - "x-typespec-name": "Record" + } } - }, - "description": "Class representing web app properties web model." + } }, "WebAppPropertiesCollection": { "type": "object", + "description": "Collection of web app properties.", "properties": { "webApps": { "type": "array", + "description": "Gets or sets the list of web app properties.", "items": { "$ref": "#/definitions/WebAppProperties" }, - "x-ms-identifiers": [], - "description": "Gets or sets the list of web app properties.", - "x-typespec-name": "WebAppProperties[]" + "x-ms-identifiers": [] } - }, - "description": "Collection of web app properties." + } }, "WebAppRunAsAccount": { "type": "object", + "description": "Run as account REST Resource.", "properties": { "properties": { "$ref": "#/definitions/RunAsAccountProperties", @@ -22325,7 +22039,6 @@ ] } }, - "description": "Run as account REST Resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -22334,29 +22047,28 @@ }, "WebAppRunAsAccountListResult": { "type": "object", + "description": "The response of a WebAppRunAsAccount list operation.", "properties": { "value": { "type": "array", + "description": "The WebAppRunAsAccount items on this page", "items": { "$ref": "#/definitions/WebAppRunAsAccount" - }, - "description": "The WebAppRunAsAccount items on this page", - "x-typespec-name": "WebAppRunAsAccount[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a WebAppRunAsAccount list operation.", "required": [ "value" ] }, "WebAppSite": { "type": "object", + "description": "WebApp site web model.", "properties": { "properties": { "$ref": "#/definitions/WebAppSiteProperties", @@ -22368,7 +22080,6 @@ ] } }, - "description": "WebApp site web model.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -22377,38 +22088,36 @@ }, "WebAppSiteListResult": { "type": "object", + "description": "The response of a WebAppSite list operation.", "properties": { "value": { "type": "array", + "description": "The WebAppSite items on this page", "items": { "$ref": "#/definitions/WebAppSite" - }, - "description": "The WebAppSite items on this page", - "x-typespec-name": "WebAppSite[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a WebAppSite list operation.", "required": [ "value" ] }, "WebAppSiteProperties": { "type": "object", + "description": "Class for Web app site properties.", "properties": { "siteAppliancePropertiesCollection": { "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", "items": { "$ref": "#/definitions/SiteApplianceProperties" }, - "x-ms-identifiers": [], - "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", - "x-typespec-name": "SiteApplianceProperties[]" + "x-ms-identifiers": [] }, "discoveryScenario": { "$ref": "#/definitions/WebAppSitePropertiesDiscoveryScenario", @@ -22424,8 +22133,7 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for Web app site properties." + } }, "WebAppSitePropertiesDiscoveryScenario": { "type": "string", @@ -22453,35 +22161,35 @@ }, "WebAppSiteUpdate": { "type": "object", + "description": "The type used for update operations of the WebAppSite.", "properties": { "properties": { "$ref": "#/definitions/WebAppSiteUpdateProperties", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the WebAppSite." + } }, "WebAppSiteUpdateProperties": { "type": "object", + "description": "The updatable properties of the WebAppSite.", "properties": { "siteAppliancePropertiesCollection": { "type": "array", + "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", "items": { "$ref": "#/definitions/SiteApplianceProperties" }, - "x-ms-identifiers": [], - "description": "Gets or sets the appliance details used by service to communicate\n \nto the appliance.", - "x-typespec-name": "SiteApplianceProperties[]" + "x-ms-identifiers": [] }, "discoveryScenario": { "$ref": "#/definitions/WebAppSitePropertiesDiscoveryScenario", "description": "Gets or sets the discovery scenario." } - }, - "description": "The updatable properties of the WebAppSite." + } }, "WebAppSiteUsage": { "type": "object", + "description": "Web app site usage.", "properties": { "webServerCount": { "type": "integer", @@ -22498,11 +22206,11 @@ "format": "int32", "description": "Gets or sets the number of run as accounts in the site." } - }, - "description": "Web app site usage." + } }, "WebApplication": { "type": "object", + "description": "Web application REST Resource.", "properties": { "properties": { "$ref": "#/definitions/WebApplicationProperties", @@ -22514,7 +22222,6 @@ ] } }, - "description": "Web application REST Resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -22523,6 +22230,7 @@ }, "WebApplicationAppsAndRolesModel": { "type": "object", + "description": "WebApplication in the guest virtual machine.", "properties": { "name": { "type": "string", @@ -22554,11 +22262,11 @@ "description": "Gets or sets ApplicationPool of the WebApplication.", "readOnly": true } - }, - "description": "WebApplication in the guest virtual machine." + } }, "WebApplicationConfigurationUnit": { "type": "object", + "description": "Web Application configuration unit.", "properties": { "name": { "type": "string", @@ -22592,11 +22300,11 @@ "type": "string", "description": "Gets or sets the identifier for the configuration." } - }, - "description": "Web Application configuration unit." + } }, "WebApplicationDirectoryUnit": { "type": "object", + "description": "Web Application directory unit.", "properties": { "id": { "type": "string", @@ -22608,11 +22316,10 @@ }, "sourcePaths": { "type": "array", + "description": "Gets or sets the paths of the directory on the source machine.", "items": { "type": "string" - }, - "description": "Gets or sets the paths of the directory on the source machine.", - "x-typespec-name": "string[]" + } }, "localScratchPath": { "type": "string", @@ -22626,11 +22333,11 @@ "type": "string", "description": "Gets or sets the size of the directory on the source machine." } - }, - "description": "Web Application directory unit." + } }, "WebApplicationFramework": { "type": "object", + "description": "Framework specific data for a web application.", "properties": { "name": { "type": "string", @@ -22640,34 +22347,32 @@ "type": "string", "description": "Gets or sets Version of the framework." } - }, - "description": "Framework specific data for a web application." + } }, "WebApplicationListResult": { "type": "object", + "description": "The response of a WebApplication list operation.", "properties": { "value": { "type": "array", + "description": "The WebApplication items on this page", "items": { "$ref": "#/definitions/WebApplication" - }, - "description": "The WebApplication items on this page", - "x-typespec-name": "WebApplication[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a WebApplication list operation.", "required": [ "value" ] }, "WebApplicationProperties": { "type": "object", + "description": "Class for web application properties.", "properties": { "webServerId": { "type": "string", @@ -22679,6 +22384,14 @@ "description": "Gets the web server name.", "readOnly": true }, + "machineArmIds": { + "type": "array", + "description": "Gets the list of machine ARM Ids on which the SQL server is deployed.", + "items": { + "type": "string" + }, + "readOnly": true + }, "virtualPath": { "type": "string", "description": "Gets the virtual path of the application.", @@ -22691,43 +22404,39 @@ }, "bindings": { "type": "array", + "description": "Gets the front end bindings for the application.", "items": { "$ref": "#/definitions/FrontEndBinding" }, - "x-ms-identifiers": [], - "description": "Gets the front end bindings for the application.", - "x-typespec-name": "FrontEndBinding[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "frameworks": { "type": "array", + "description": "Gets the Error details.", "items": { "$ref": "#/definitions/WebApplicationFramework" }, - "x-ms-identifiers": [], - "description": "Gets the Error details.", - "x-typespec-name": "WebApplicationFramework[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "configurations": { "type": "array", + "description": "Gets the configuration.", "items": { "$ref": "#/definitions/WebApplicationConfigurationUnit" }, - "x-ms-identifiers": [], - "description": "Gets the configuration.", - "x-typespec-name": "WebApplicationConfigurationUnit[]", - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "directories": { "type": "array", + "description": "Gets the directories.", "items": { "$ref": "#/definitions/WebApplicationDirectoryUnit" }, - "description": "Gets the directories.", - "x-typespec-name": "WebApplicationDirectoryUnit[]", - "x-ms-identifiers": [], - "readOnly": true + "readOnly": true, + "x-ms-identifiers": [] }, "displayName": { "type": "string", @@ -22736,20 +22445,18 @@ }, "tags": { "type": "object", + "description": "Gets tags that can be used with ODATA.", "additionalProperties": { "type": "string" }, - "description": "Gets tags that can be used with ODATA.", - "x-typespec-name": "Record", "readOnly": true }, "staticFolders": { "type": "array", + "description": "Static folders.", "items": { "type": "string" }, - "description": "Static folders.", - "x-typespec-name": "string[]", "readOnly": true }, "machineDisplayName": { @@ -22779,20 +22486,18 @@ }, "errors": { "type": "array", + "description": "Gets the Error details.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets the Error details.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "applianceNames": { "type": "array", + "description": "Gets the appliance names.", "items": { "type": "string" }, - "description": "Gets the appliance names.", - "x-typespec-name": "string[]", "readOnly": true }, "hasErrors": { @@ -22805,11 +22510,11 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for web application properties." + } }, "WebRoleImportDisk": { "type": "object", + "description": "Class representing the imported machine web model.", "properties": { "megabytesPerSecondOfRead": { "type": "number", @@ -22857,11 +22562,11 @@ "type": "string", "description": "Gets or sets Path of the disk." } - }, - "description": "Class representing the imported machine web model." + } }, "WebRoleOperatingSystem": { "type": "object", + "description": "Second level object returned as part of Machine REST resource.", "properties": { "osType": { "type": "string", @@ -22879,11 +22584,11 @@ "type": "string", "description": "Gets or sets the Architecture of the operating system." } - }, - "description": "Second level object returned as part of Machine REST resource." + } }, "WebServer": { "type": "object", + "description": "Web application REST Resource.", "properties": { "properties": { "$ref": "#/definitions/WebServerProperties", @@ -22895,7 +22600,6 @@ ] } }, - "description": "Web application REST Resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" @@ -22904,29 +22608,28 @@ }, "WebServerListResult": { "type": "object", + "description": "The response of a WebServer list operation.", "properties": { "value": { "type": "array", + "description": "The WebServer items on this page", "items": { "$ref": "#/definitions/WebServer" - }, - "description": "The WebServer items on this page", - "x-typespec-name": "WebServer[]" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a WebServer list operation.", "required": [ "value" ] }, "WebServerProperties": { "type": "object", + "description": "Class for web server properties.", "properties": { "configurationLocation": { "type": "string", @@ -22940,20 +22643,18 @@ }, "machineIds": { "type": "array", + "description": "Gets the list of machines.", "items": { "type": "string" }, - "description": "Gets the list of machines.", - "x-typespec-name": "string[]", "readOnly": true }, "webApplications": { "type": "array", + "description": "Gets the list of web applications.", "items": { "type": "string" }, - "description": "Gets the list of web applications.", - "x-typespec-name": "string[]", "readOnly": true }, "displayName": { @@ -22993,20 +22694,18 @@ }, "errors": { "type": "array", + "description": "Gets the Error details.", "items": { "$ref": "#/definitions/HealthErrorDetails" }, - "description": "Gets the Error details.", - "x-typespec-name": "HealthErrorDetails[]", "readOnly": true }, "applianceNames": { "type": "array", + "description": "Gets the appliance names.", "items": { "type": "string" }, - "description": "Gets the appliance names.", - "x-typespec-name": "string[]", "readOnly": true }, "hasErrors": { @@ -23019,8 +22718,7 @@ "description": "provisioning state enum", "readOnly": true } - }, - "description": "Class for web server properties." + } }, "esuStatus": { "type": "string", diff --git a/specification/mpcnetworkfunction/resource-manager/readme.java.md b/specification/mpcnetworkfunction/resource-manager/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/mpcnetworkfunction/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json new file mode 100644 index 000000000000..cf3bed240afa --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json @@ -0,0 +1,981 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-07-31-preview", + "title": "ManagedServiceIdentityClient", + "description": "The Managed Service Identity Client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.ManagedIdentity/identities/default": { + "get": { + "operationId": "SystemAssignedIdentities_GetByScope", + "description": "Gets the systemAssignedIdentity available under the specified RP scope.", + "x-ms-examples": { + "MsiOperationsList": { + "$ref": "./examples/SystemAssignedIdentityGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The systemAssignedIdentity was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/SystemAssignedIdentity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.ManagedIdentity/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists available operations for the Microsoft.ManagedIdentity provider", + "x-ms-examples": { + "MsiOperationsList": { + "$ref": "./examples/MsiOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedIdentity/userAssignedIdentities": { + "get": { + "operationId": "UserAssignedIdentities_ListBySubscription", + "description": "Lists all the userAssignedIdentities available under the specified subscription.", + "x-ms-examples": { + "IdentityListBySubscription": { + "$ref": "./examples/IdentityListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of userAssignedIdentities was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UserAssignedIdentitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities": { + "get": { + "operationId": "UserAssignedIdentities_ListByResourceGroup", + "description": "Lists all the userAssignedIdentities available under the specified ResourceGroup.", + "x-ms-examples": { + "IdentityListByResourceGroup": { + "$ref": "./examples/IdentityListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of userAssignedIdentities was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UserAssignedIdentitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}": { + "put": { + "operationId": "UserAssignedIdentities_CreateOrUpdate", + "description": "Create or update an identity in the specified subscription and resource group.", + "x-ms-examples": { + "IdentityCreate": { + "$ref": "./examples/IdentityCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Identity" + }, + "description": "Parameters to create or update the identity" + } + ], + "responses": { + "200": { + "description": "Updated identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "201": { + "description": "Created identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "operationId": "UserAssignedIdentities_Update", + "description": "Update an identity in the specified subscription and resource group.", + "x-ms-examples": { + "IdentityUpdate": { + "$ref": "./examples/IdentityUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IdentityUpdate" + }, + "description": "Parameters to update the identity" + } + ], + "responses": { + "200": { + "description": "Updated identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "operationId": "UserAssignedIdentities_Get", + "description": "Gets the identity.", + "x-ms-examples": { + "IdentityGet": { + "$ref": "./examples/IdentityGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The requested identity.", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "UserAssignedIdentities_Delete", + "description": "Deletes the identity.", + "x-ms-examples": { + "IdentityDelete": { + "$ref": "./examples/IdentityDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Deleted Identity." + }, + "204": { + "description": "The specified identity does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{revokeTokenResourceName}/revokeTokens": { + "post": { + "operationId": "UserAssignedIdentities_RevokeTokens", + "description": "Revoke all tokens issued in the past for a specified user assigned identity.", + "x-ms-examples": { + "TokenRevocation": { + "$ref": "./examples/TokenRevocation.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RevokeTokensResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Accepted request to revoke all tokens issued for a specified user assigned identity before the current time." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials": { + "get": { + "operationId": "FederatedIdentityCredentials_List", + "description": "Lists all the federated identity credentials under the specified user assigned identity.", + "x-ms-examples": { + "FederatedIdentityCredentialList": { + "$ref": "./examples/FederatedIdentityCredentialList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TopQueryParameter" + }, + { + "$ref": "#/parameters/SkipTokenParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of federated identity credentials for the specified user assigned identity was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredentialsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}/federatedIdentityCredentials/{federatedIdentityCredentialResourceName}": { + "put": { + "operationId": "FederatedIdentityCredentials_CreateOrUpdate", + "description": "Create or update a federated identity credential under the specified user assigned identity.", + "x-ms-examples": { + "FederatedIdentityCredentialCreate": { + "$ref": "./examples/FederatedIdentityCredentialCreate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + }, + "description": "Parameters to create or update the federated identity credential." + } + ], + "responses": { + "200": { + "description": "Updated federated identity credential.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + } + }, + "201": { + "description": "Created federated identity credential.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "operationId": "FederatedIdentityCredentials_Get", + "description": "Gets the federated identity credential.", + "x-ms-examples": { + "FederatedIdentityCredentialGet": { + "$ref": "./examples/FederatedIdentityCredentialGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The requested federated identity credential.", + "schema": { + "$ref": "#/definitions/FederatedIdentityCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "FederatedIdentityCredentials_Delete", + "description": "Deletes the federated identity credential.", + "x-ms-examples": { + "FederatedIdentityCredentialDelete": { + "$ref": "./examples/FederatedIdentityCredentialDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/FederatedIdentityCredentialResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Deleted federated identity credential." + }, + "204": { + "description": "The specified federated identity credential does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "Identity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "description": "The properties associated with the identity.", + "$ref": "#/definitions/UserAssignedIdentityProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes an identity resource." + }, + "FederatedIdentityCredential": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties associated with the federated identity credential.", + "$ref": "#/definitions/FederatedIdentityCredentialProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource" + } + ], + "description": "Describes a federated identity credential." + }, + "IdentityUpdate": { + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "description": "The properties associated with the identity.", + "$ref": "#/definitions/UserAssignedIdentityProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/Resource" + } + ], + "description": "Describes an identity resource." + }, + "SystemAssignedIdentity": { + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "description": "The properties associated with the identity.", + "$ref": "#/definitions/SystemAssignedIdentityProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource" + } + ], + "description": "Describes a system assigned identity resource." + }, + "SystemAssignedIdentityProperties": { + "description": "The properties associated with the system assigned identity.", + "type": "object", + "title": "System Assigned Identity properties.", + "properties": { + "tenantId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the tenant which the identity belongs to." + }, + "principalId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the service principal object associated with the created identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the app associated with the identity. This is a random generated UUID by MSI." + }, + "clientSecretUrl": { + "type": "string", + "readOnly": true, + "description": " The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials." + } + } + }, + "UserAssignedIdentityProperties": { + "description": "The properties associated with the user assigned identity.", + "type": "object", + "title": "User Assigned Identity properties.", + "properties": { + "tenantId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the tenant which the identity belongs to." + }, + "principalId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the service principal object associated with the created identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the app associated with the identity. This is a random generated UUID by MSI." + } + } + }, + "FederatedIdentityCredentialProperties": { + "description": "The properties associated with a federated identity credential.", + "type": "object", + "title": "Federated identity credential properties.", + "required": [ + "issuer", + "subject", + "audiences" + ], + "properties": { + "issuer": { + "type": "string", + "format": "uri", + "description": "The URL of the issuer to be trusted." + }, + "subject": { + "type": "string", + "description": "The identifier of the external identity." + }, + "audiences": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of audiences that can appear in the issued token." + } + } + }, + "FederatedIdentityCredentialsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FederatedIdentityCredential" + }, + "x-ms-identifiers": [ + "id" + ], + "description": "The collection of federated identity credentials returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The url to get the next page of results, if any." + } + }, + "description": "Values returned by the List operation for federated identity credentials." + }, + "UserAssignedIdentitiesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Identity" + }, + "description": "The collection of userAssignedIdentities returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The url to get the next page of results, if any." + } + }, + "description": "Values returned by the List operation." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "description": "A list of additional details about the error.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the ManagedServiceIdentity service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "code" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the ManagedServiceIdentity service." + }, + "Operation": { + "title": "Microsoft.ManagedIdentity Operation.", + "description": "Operation supported by the Microsoft.ManagedIdentity REST API.", + "type": "object", + "properties": { + "name": { + "title": "Operation Name.", + "description": "The name of the REST Operation. This is of the format {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "title": "Operation Display.", + "description": "The object that describes the operation.", + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "title": "Operation Display.", + "description": "The object that describes the operation.", + "properties": { + "provider": { + "title": "Resource Provider Name.", + "description": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "title": "Operation Type.", + "description": "The type of operation. For example: read, write, delete.", + "type": "string" + }, + "resource": { + "title": "Resource Type.", + "description": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "title": "Operation description", + "description": "A description of the operation.", + "type": "string" + } + } + }, + "OperationListResult": { + "title": "Operations List.", + "description": "A list of operations supported by Microsoft.ManagedIdentity Resource Provider.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "title": "Operations List.", + "description": "A list of operations supported by Microsoft.ManagedIdentity Resource Provider." + }, + "nextLink": { + "type": "string", + "title": "Next Link", + "description": "The url to get the next page of results, if any." + } + } + } + }, + "parameters": { + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The resource provider scope of the resource. Parent resource being extended by Managed Identities.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Id of the Subscription to which the identity belongs.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the Resource Group to which the identity belongs.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "description": "The name of the identity resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of API to invoke.", + "required": true, + "type": "string" + }, + "TopQueryParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Number of records to return.", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "SkipTokenParameter": { + "in": "query", + "name": "$skiptoken", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "FederatedIdentityCredentialResourceNameParameter": { + "name": "federatedIdentityCredentialResourceName", + "in": "path", + "description": "The name of the federated identity credential resource.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{2,119}$", + "x-ms-parameter-location": "method" + }, + "RevokeTokensResourceNameParameter": { + "name": "revokeTokenResourceName", + "in": "path", + "description": "The name of the identity resource for revoking token", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{2,119}$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialCreate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialCreate.json new file mode 100644 index 000000000000..2014de5a6387 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialCreate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "federatedIdentityCredentialResourceName": "ficResourceName", + "parameters": { + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + }, + "200": { + "body": { + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialDelete.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialDelete.json new file mode 100644 index 000000000000..803cb1895bde --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "federatedIdentityCredentialResourceName": "ficResourceName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialGet.json new file mode 100644 index 000000000000..b0ab5fd490e3 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "federatedIdentityCredentialResourceName": "ficResourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialList.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialList.json new file mode 100644 index 000000000000..34184d618247 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/FederatedIdentityCredentialList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "top": "20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName/federatedIdentityCredentials/ficResourceName", + "name": "ficResourceName", + "properties": { + "issuer": "https://oidc.prod-aks.azure.com/TenantGUID/IssuerGUID", + "subject": "system:serviceaccount:ns:svcaccount", + "audiences": [ + "api://AzureADTokenExchange" + ] + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities/federatedIdentityCredentials" + } + ], + "nextLink": "https://serviceRoot/subscriptions/c267c0e7-0a73-4789-9e17-d26aeb0904e5/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/resourceName/federatedIdentityCredentials?api-version=2023-01-31&$skipToken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityCreate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityCreate.json new file mode 100644 index 000000000000..b60b28dce194 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityCreate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "parameters": { + "location": "eastus", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityDelete.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityDelete.json new file mode 100644 index 000000000000..c8a36abb41ce --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityGet.json new file mode 100644 index 000000000000..72cfcafb21a5 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityListByResourceGroup.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityListByResourceGroup.json new file mode 100644 index 000000000000..37972ef028e9 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2023-01-31&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityListBySubscription.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityListBySubscription.json new file mode 100644 index 000000000000..81b33a928ea3 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityListBySubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2023-01-31&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityUpdate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityUpdate.json new file mode 100644 index 000000000000..aa9aad1872e1 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/IdentityUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "parameters": { + "location": "eastus", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "eastus", + "name": "identityName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/MsiOperationsList.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/MsiOperationsList.json new file mode 100644 index 000000000000..8b20d76b6dd2 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/MsiOperationsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets an existing user assigned identity", + "operation": "Get User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/read" + }, + { + "display": { + "description": "Creates a new user assigned identity or updates the tags associated with an existing user assigned identity", + "operation": "Create/Update User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/write" + }, + { + "display": { + "description": "Deletes an existing user assigned identity", + "operation": "Delete User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/delete" + } + ], + "nextLink": "https://serviceRoot/providers/Microsoft.ManagedIdentity/operations?api-version=2023-01-31&$skiptoken=X'12345'" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/SystemAssignedIdentityGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/SystemAssignedIdentityGet.json new file mode 100644 index 000000000000..ed17103a5adf --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/SystemAssignedIdentityGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "scope": "scope" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.Compute/virtualMachines/identityName", + "location": "cus", + "name": "resourceName", + "properties": { + "clientId": "4024ab25-56a8-4370-aea6-6389221caf29", + "clientSecretUrl": "https://serviceRoot/scope/credentials?tid=tenantId&oid=principalId&aid=clientId", + "principalId": "25cc773c-7f05-40fc-a104-32d2300754ad", + "tenantId": "b6c948ef-f6b5-4384-8354-da3a15eca969" + }, + "type": "ResourceProvider" + } + } + } +} diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/TokenRevocation.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/TokenRevocation.json new file mode 100644 index 000000000000..57f680175398 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2023-07-31-preview/examples/TokenRevocation.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-07-31-preview", + "subscriptionId": "c267c0e7-0a73-4789-9e17-d26aeb0904e5", + "resourceGroupName": "rgName", + "revokeTokenResourceName": "resourceName" + }, + "responses": { + "200": {} + } +} diff --git a/specification/msi/resource-manager/readme.md b/specification/msi/resource-manager/readme.md index 2a00ea562d33..bcbb2f549c26 100644 --- a/specification/msi/resource-manager/readme.md +++ b/specification/msi/resource-manager/readme.md @@ -29,6 +29,15 @@ openapi-type: arm tag: package-2023-01-31 ``` +### Tag: package-2023-07-31-preview + +These settings apply only when `--tag=package-2023-07-31-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2023-07-31-preview' +input-file: +- Microsoft.ManagedIdentity/preview/2023-07-31-preview/ManagedIdentity.json +``` + ### Tag: package-2023-01-31 These settings apply only when `--tag=package-2023-01-31` is specified on the command line. diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..32938b88c538 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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/2023-05-01-preview/examples/Accounts_CreateOrUpdateAD.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_CreateOrUpdateAD.json new file mode 100644 index 000000000000..dae43d4bc575 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_CreateOrUpdateAD.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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, 10.10.10.4", + "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, 10.10.10.4", + "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, 10.10.10.4", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_Delete.json new file mode 100644 index 000000000000..f09c5773e2b1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_Get.json new file mode 100644 index 000000000000..85d0627a6bb5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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, 10.10.10.4", + "status": "InUse", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "statusDetails": "Status Details", + "aesEncryption": true, + "ldapSigning": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_List.json new file mode 100644 index 000000000000..605194327c20 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2023-05-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/2023-05-01-preview/examples/Accounts_MigrateEncryptionKey.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_MigrateEncryptionKey.json new file mode 100644 index 000000000000..4d0a5fef9961 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_MigrateEncryptionKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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=2023-05-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=2023-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_RenewCredentials.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_RenewCredentials.json new file mode 100644 index 000000000000..8440ba819025 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_RenewCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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=2022-08-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_Update.json new file mode 100644 index 000000000000..44804d2a9c47 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Accounts_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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=2021-08-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/preview/2023-05-01-preview/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..1fc47c2613d5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..cc69a7bf2bac --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..88e7b87e42b2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-01-preview" + }, + "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": "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/2023-05-01-preview/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..0ac5f8c05dee --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupPolicies_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/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/2023-05-01-preview/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..40fa645307cf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupPolicies_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2023-05-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/backupPolicies/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=2021-08-01&operationResultResponseType=Location" + }, + "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": { + "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/2023-05-01-preview/examples/BackupVaults_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupVaults_Create.json new file mode 100644 index 000000000000..1a7bb189b0ba --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/BackupVaults_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupVaults_Delete.json new file mode 100644 index 000000000000..f779ddb8cfbd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2023-05-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=2023-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupVaults_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupVaults_Get.json new file mode 100644 index 000000000000..067222bbdcef --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/BackupVaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupVaults_List.json new file mode 100644 index 000000000000..adf8f383c3d8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupVaults_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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/2023-05-01-preview/examples/BackupVaults_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupVaults_Update.json new file mode 100644 index 000000000000..a2685768ea5f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2023-05-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=2023-05-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/2023-05-01-preview/examples/BackupsUnderAccount_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderAccount_Migrate.json new file mode 100644 index 000000000000..d8b1dcca9427 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderAccount_Migrate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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=2023-05-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=2023-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_Create.json new file mode 100644 index 000000000000..6ff83a1e7b79 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/BackupsUnderBackupVault_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_Delete.json new file mode 100644 index 000000000000..0b6cb0416124 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2023-05-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=2023-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_Get.json new file mode 100644 index 000000000000..ce62c01ef93a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2023-05-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" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_List.json new file mode 100644 index 000000000000..0db69ccb9706 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2023-05-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" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json new file mode 100644 index 000000000000..79c535a40c8e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2023-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderBackupVault_Update.json new file mode 100644 index 000000000000..9085107627b0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-08-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=2021-08-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/preview/2023-05-01-preview/examples/BackupsUnderVolume_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderVolume_Migrate.json new file mode 100644 index 000000000000..4c15a0626965 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/BackupsUnderVolume_Migrate.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-05-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=2023-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Backups_Account_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Backups_Account_Delete.json new file mode 100644 index 000000000000..8d65f65d3a09 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Backups_Account_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "backupName": "backupName", + "api-version": "2023-05-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=2023-05-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=2023-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Backups_Account_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Backups_Account_Get.json new file mode 100644 index 000000000000..3e13a6758007 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Backups_Account_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupName": "backup1", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/accountBackups/backup1", + "name": "account1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/accountBackups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "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/2023-05-01-preview/examples/Backups_Account_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Backups_Account_List.json new file mode 100644 index 000000000000..06fd62d4919e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Backups_Account_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/accountBackups/backup1", + "name": "account1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/accountBackups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "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/2023-05-01-preview/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..334047cb6c13 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-05-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/2023-05-01-preview/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..d25f0abbe606 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-05-01-preview", + "body": { + "name": "accName", + "type": "netAppAccount", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..48c9ad00f13d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-05-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/2023-05-01-preview/examples/GroupIdListForLDAPUser.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/GroupIdListForLDAPUser.json new file mode 100644 index 000000000000..002a075b1581 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2022-11-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=2022-11-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/NetworkSiblingSet_Query.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/NetworkSiblingSet_Query.json new file mode 100644 index 000000000000..c7f31c003d83 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/NetworkSiblingSet_Query.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-05-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/2023-05-01-preview/examples/NetworkSiblingSet_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/NetworkSiblingSet_Update.json new file mode 100644 index 000000000000..a6949f23d2eb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/NetworkSiblingSet_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-05-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=2023-01-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/OperationList.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/OperationList.json new file mode 100644 index 000000000000..aba5f8460c5a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/OperationList.json @@ -0,0 +1,1565 @@ +{ + "parameters": { + "api-version": "2023-05-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/2023-05-01-preview/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..6473a83d8b24 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Pools_Delete.json new file mode 100644 index 000000000000..67f9bb5e634a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Pools_Get.json new file mode 100644 index 000000000000..a6c6bdfdb53d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Pools_List.json new file mode 100644 index 000000000000..902ba4a1fba5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Pools_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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/2023-05-01-preview/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Pools_Update.json new file mode 100644 index 000000000000..7dca44c81667 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/QuotaLimits_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/QuotaLimits_Get.json new file mode 100644 index 000000000000..5ef3c4302b2e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/QuotaLimits_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "quotaLimitName": "totalCoolAccessVolumesPerSubscription", + "api-version": "2023-05-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/2023-05-01-preview/examples/QuotaLimits_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/QuotaLimits_List.json new file mode 100644 index 000000000000..52db1bfc2d76 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/QuotaLimits_List.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-05-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/2023-05-01-preview/examples/RegionInfo.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/RegionInfo.json new file mode 100644 index 000000000000..b7717d4964fe --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/RegionInfo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/RegionInfos_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/RegionInfos_Get.json new file mode 100644 index 000000000000..53e4eae2db71 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/RegionInfos_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-05-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/2023-05-01-preview/examples/RegionInfos_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/RegionInfos_List.json new file mode 100644 index 000000000000..6ed0cdf85fa0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/RegionInfos_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-05-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/2023-05-01-preview/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..e7ee7c6e8494 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..d5ebe6531b48 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..45a89c059298 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..25e2b71156a8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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/2023-05-01-preview/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..bbd08ff4370f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..22903b7044f3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-08-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/preview/2023-05-01-preview/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Snapshots_Create.json new file mode 100644 index 000000000000..1b73c09b66e0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Snapshots_Create.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2023-05-01-preview", + "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/2023-05-01-preview/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..6aa8fa559787 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Snapshots_Get.json new file mode 100644 index 000000000000..9f04a171afc1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Snapshots_List.json new file mode 100644 index 000000000000..128fbcd0907e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/Snapshots_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Snapshots_SingleFileRestore.json new file mode 100644 index 000000000000..9bb62bc803e5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Snapshots_Update.json new file mode 100644 index 000000000000..bc2efd415bdc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Create.json new file mode 100644 index 000000000000..1523b87552ab --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Create.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-05-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" + } + } + }, + "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/2023-05-01-preview/examples/Subvolumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Delete.json new file mode 100644 index 000000000000..a9bf729dc305 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Get.json new file mode 100644 index 000000000000..4d7ac1ce0a8a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-05-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" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_List.json new file mode 100644 index 000000000000..f53e866ecf19 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-05-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" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Metadata.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Metadata.json new file mode 100644 index 000000000000..6425b02efa4e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Update.json new file mode 100644 index 000000000000..c97bce63a7db --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Subvolumes_Update.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-05-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" + } + } + }, + "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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_Create_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_Create_Oracle.json new file mode 100644 index 000000000000..44ea10af1b52 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/VolumeGroups_Create_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_Create_SapHana.json new file mode 100644 index 000000000000..0e1a9fd20730 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/VolumeGroups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_Delete.json new file mode 100644 index 000000000000..de9bd4907f31 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_Get_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_Get_Oracle.json new file mode 100644 index 000000000000..52e0ecfda8d3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/VolumeGroups_Get_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_Get_SapHana.json new file mode 100644 index 000000000000..a9d2fc4d7ecd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/VolumeGroups_List_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_List_Oracle.json new file mode 100644 index 000000000000..7d899f67dec8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_List_Oracle.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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/2023-05-01-preview/examples/VolumeGroups_List_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_List_SapHana.json new file mode 100644 index 000000000000..1b8ab58477b8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeGroups_List_SapHana.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-05-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": "DEV", + "volumesCount": 5 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeQuotaRules_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeQuotaRules_Create.json new file mode 100644 index 000000000000..3a80859caff7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-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/preview/2023-05-01-preview/examples/VolumeQuotaRules_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeQuotaRules_Delete.json new file mode 100644 index 000000000000..cd10d4b0551b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeQuotaRules_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeQuotaRules_Get.json new file mode 100644 index 000000000000..aecc5cf44f71 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/VolumeQuotaRules_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeQuotaRules_List.json new file mode 100644 index 000000000000..01dcdd918ac3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/VolumeQuotaRules_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/VolumeQuotaRules_Update.json new file mode 100644 index 000000000000..2b3c79aeabb0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..2c5712cdc3a0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_BreakFileLocks.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_BreakFileLocks.json new file mode 100644 index 000000000000..ecc797da5529 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..d9d2aa3e4b10 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..6f0ada3882fb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_CreateOrUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-05-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, + "throughputMibps": 128, + "encryptionKeySource": "Microsoft.KeyVault" + } + } + }, + "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.KeyVault" + }, + "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.KeyVault" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Delete.json new file mode 100644 index 000000000000..323320f70b72 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..b12031a489d2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_FinalizeRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_FinalizeRelocation.json new file mode 100644 index 000000000000..b12031a489d2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Get.json new file mode 100644 index 000000000000..68d78930f168 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-05-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": 0, + "actualThroughputMibps": 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/2023-05-01-preview/examples/Volumes_LatestBackupStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_LatestBackupStatus.json new file mode 100644 index 000000000000..5e201d852ffd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_List.json new file mode 100644 index 000000000000..88a8cdeb97a4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-05-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": 0, + "actualThroughputMibps": 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/2023-05-01-preview/examples/Volumes_ListReplications.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_ListReplications.json new file mode 100644 index 000000000000..97301f6fcd57 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..bf0faa09a6ee --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_PopulateAvailabilityZones.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_PopulateAvailabilityZones.json new file mode 100644 index 000000000000..d3a53d6f8cb9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..b12031a489d2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_ReestablishReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_ReestablishReplication.json new file mode 100644 index 000000000000..e8a346d130ac --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Relocate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Relocate.json new file mode 100644 index 000000000000..dbc4f82b75f3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..60dbdbb4bd65 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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/2023-05-01-preview/examples/Volumes_ResetCifsPassword.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_ResetCifsPassword.json new file mode 100644 index 000000000000..d52167e17b3c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_RestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_RestoreStatus.json new file mode 100644 index 000000000000..5fe4c2ced472 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_RestoreStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-05-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/2023-05-01-preview/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..b12031a489d2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Revert.json new file mode 100644 index 000000000000..b24456c33d09 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_RevertRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_RevertRelocation.json new file mode 100644 index 000000000000..b12031a489d2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_SplitClone.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_SplitClone.json new file mode 100644 index 000000000000..4a599577e13f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-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": "2023-05-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Update.json new file mode 100644 index 000000000000..2eba1c4f4cd5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/examples/Volumes_Update.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-05-01-preview", + "body": { + "location": "eastus", + "properties": { + "dataProtection": { + "backup": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "backupEnabled": true, + "policyEnforced": false + } + } + } + } + }, + "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": 0, + "actualThroughputMibps": 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" + }, + "backup": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "backupEnabled": true, + "policyEnforced": 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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/netapp.json new file mode 100644 index 000000000000..ec7ba6369600 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2023-05-01-preview/netapp.json @@ -0,0 +1,9476 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2023-05-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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_Get.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}/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." + } + }, + "x-ms-examples": { + "RegionInfo_Query": { + "$ref": "examples/RegionInfo.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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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": "#/definitions/cloudError" + } + } + }, + "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." + } + }, + "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}/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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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": "#/definitions/cloudError" + } + } + }, + "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." + } + }, + "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." + } + }, + "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", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "x-ms-examples": { + "SnapshotPolicies_ListVolumes": { + "$ref": "examples/SnapshotPolicies_ListVolumes.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}/restoreStatus": { + "get": { + "tags": [ + "Restore" + ], + "summary": "Get volume's restore status", + "description": "Get the status of the restore for a volume", + "operationId": "Backups_GetVolumeRestoreStatus", + "parameters": [ + { + "$ref": "../../../../../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." + } + }, + "x-ms-examples": { + "Volumes_RestoreStatus": { + "$ref": "examples/Volumes_RestoreStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/accountBackups": { + "get": { + "tags": [ + "Backups" + ], + "summary": "List Backups for a Netapp Account", + "description": "List all Backups for a Netapp Account", + "operationId": "AccountBackups_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" + }, + { + "in": "query", + "name": "includeOnlyBackupsFromDeletedVolumes", + "type": "string", + "description": "An option to specify whether to return backups only from deleted volumes", + "required": false + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "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": { + "AccountBackups_List": { + "$ref": "examples/Backups_Account_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/accountBackups/{backupName}": { + "get": { + "tags": [ + "Backups" + ], + "summary": "Get Backup for a Netapp Account", + "description": "Gets the specified backup for a Netapp Account", + "operationId": "AccountBackups_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/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": { + "AccountBackups_Get": { + "$ref": "examples/Backups_Account_Get.json" + } + } + }, + "delete": { + "tags": [ + "Backups" + ], + "summary": "Delete Backup for a Netapp Account", + "description": "Delete the specified Backup for a Netapp Account", + "operationId": "AccountBackups_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/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": { + "AccountBackups_Delete": { + "$ref": "examples/Backups_Account_Delete.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}/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." + } + }, + "x-ms-examples": { + "Backups_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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Backups_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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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." + } + }, + "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}/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" + }, + "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", + "keyVaultResourceId" + ], + "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." + }, + "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 multiply of 4398046511104).", + "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 multiply of 4398046511104).", + "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. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.", + "minimum": 107374182400, + "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": "UUID v4 or resource identifier used to identify the Snapshot.", + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "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": "UUID v4 or resource identifier used to identify the Backup.", + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "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" + } + } + }, + "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": 7, + "maximum": 63, + "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 + }, + "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 + } + } + }, + "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 + } + } + } + }, + "volumeBackupProperties": { + "description": "Volume Backup Properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "description": "Backup Policy Resource ID" + }, + "policyEnforced": { + "type": "boolean", + "description": "Policy Enforced" + }, + "backupEnabled": { + "type": "boolean", + "description": "Backup Enabled" + }, + "backupVaultId": { + "type": "string", + "description": "Backup Vault Resource ID" + } + } + }, + "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" + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "$ref": "#/definitions/remotePath", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "required": [ + "externalHostName", + "serverName", + "volumeName" + ], + "properties": { + "externalHostName": { + "type": "string", + "description": "The Path to a Ontap Host" + }, + "serverName": { + "type": "string", + "description": "The name of a server on the Ontap Host" + }, + "volumeName": { + "type": "string", + "description": "The name of a volume on the server" + } + } + }, + "replication": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "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. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.", + "minimum": 107374182400, + "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" + ] + } + } + }, + "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": 7, + "maximum": 63, + "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" + } + } + }, + "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" + ] + }, + "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" + } + } + }, + "backupPatchProperties": { + "description": "Backup patch properties", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Label for backup" + } + } + }, + "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" + }, + "backupsCount": { + "type": "integer", + "description": "Total count of backups for volume", + "format": "int32" + }, + "policyEnabled": { + "type": "boolean", + "description": "Policy enabled" + } + } + }, + "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" + ], + "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" + } + } + }, + "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" + ], + "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" + } + } + }, + "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" + } + } + }, + "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, + "x-ms-mutability": [ + "create", + "update" + ], + "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", + "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", + "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" + } + } + }, + "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" + } + } + }, + "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" + } + }, + "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" + }, + "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" + }, + "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" + }, + "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/2023-07-01/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..4e1298a82f03 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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/2023-07-01/examples/Accounts_CreateOrUpdateAD.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdateAD.json new file mode 100644 index 000000000000..bd3f81610238 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdateAD.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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, 10.10.10.4", + "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, 10.10.10.4", + "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, 10.10.10.4", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_Delete.json new file mode 100644 index 000000000000..271b4fac8baf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_Get.json new file mode 100644 index 000000000000..8739187066b5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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, 10.10.10.4", + "status": "InUse", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "statusDetails": "Status Details", + "aesEncryption": true, + "ldapSigning": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_List.json new file mode 100644 index 000000000000..3125449ef32e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2023-07-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/2023-07-01/examples/Accounts_RenewCredentials.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_RenewCredentials.json new file mode 100644 index 000000000000..30298e0769b6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_RenewCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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=2022-09-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_Update.json new file mode 100644 index 000000000000..bc26524ea6df --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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=2022-09-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Patching", + "encryption": { + "keySource": "Microsoft.NetApp" + } + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..54c1b9eab674 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2023-07-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/backupPolocies/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/backupPolocies/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/2023-07-01/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..4201d30d3c41 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "backupPolicyName": "backupPolicyName", + "api-version": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..7f907acc4040 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2023-07-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/2023-07-01/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..3358342d332c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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/2023-07-01/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..636140af2712 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/BackupPolicies_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2023-07-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=2022-09-01&operationResultResponseType=Location" + }, + "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/2023-07-01/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..0a44545c8053 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-07-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/2023-07-01/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..b139c38cac74 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-07-01", + "body": { + "name": "accName", + "type": "netAppAccount", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..1294cd86cb95 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-07-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/2023-07-01/examples/GroupIdListForLDAPUser.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/GroupIdListForLDAPUser.json new file mode 100644 index 000000000000..78fe6408e469 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2023-07-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=2023-07-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/NetworkSiblingSet_Query.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/NetworkSiblingSet_Query.json new file mode 100644 index 000000000000..2b87ad1082ae --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/NetworkSiblingSet_Query.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-07-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/2023-07-01/examples/NetworkSiblingSet_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/NetworkSiblingSet_Update.json new file mode 100644 index 000000000000..5098064f7687 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/NetworkSiblingSet_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-07-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=2023-01-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/OperationList.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/OperationList.json new file mode 100644 index 000000000000..80cd17dbc5d6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/OperationList.json @@ -0,0 +1,1565 @@ +{ + "parameters": { + "api-version": "2023-07-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/2023-07-01/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..96a8630d72d4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-07-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/2023-07-01/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_Delete.json new file mode 100644 index 000000000000..bd1765829030 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_Get.json new file mode 100644 index 000000000000..c26585af3965 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-07-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/2023-07-01/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_List.json new file mode 100644 index 000000000000..5a2c06eacfbf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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/2023-07-01/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_Update.json new file mode 100644 index 000000000000..1d87c459702d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Pools_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/QuotaLimits_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/QuotaLimits_Get.json new file mode 100644 index 000000000000..4dea6a25cf5f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/QuotaLimits_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "quotaLimitName": "totalCoolAccessVolumesPerSubscription", + "api-version": "2023-07-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/2023-07-01/examples/QuotaLimits_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/QuotaLimits_List.json new file mode 100644 index 000000000000..8e7cfaa45f1a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/QuotaLimits_List.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-07-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/2023-07-01/examples/RegionInfo.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/RegionInfo.json new file mode 100644 index 000000000000..d7506914d815 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/RegionInfo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2023-07-01" + }, + "responses": { + "200": { + "body": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..713341d0d416 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2023-07-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/2023-07-01/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..d48e36c2b340 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..f9ad6b86cb75 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2023-07-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/2023-07-01/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..c6bd605cb96f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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/2023-07-01/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..7aeea61732a1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_ListVolumes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2023-07-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/2023-07-01/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..aa78c7aed1b0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/SnapshotPolicies_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2023-07-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=2022-09-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Snapshots_Create.json new file mode 100644 index 000000000000..be9899c729b9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..318588b18afd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Snapshots_Get.json new file mode 100644 index 000000000000..c312be7f2170 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Snapshots_List.json new file mode 100644 index 000000000000..b42307b72e6c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/Snapshots_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Snapshots_SingleFileRestore.json new file mode 100644 index 000000000000..44ddf900b385 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Snapshots_Update.json new file mode 100644 index 000000000000..d68f88c84258 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Create.json new file mode 100644 index 000000000000..c88b46719869 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Create.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-07-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" + } + } + }, + "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/2023-07-01/examples/Subvolumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Delete.json new file mode 100644 index 000000000000..69a2abda19a4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Get.json new file mode 100644 index 000000000000..2df6a6526897 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-07-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" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_List.json new file mode 100644 index 000000000000..455f8359b591 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-07-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" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Metadata.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Metadata.json new file mode 100644 index 000000000000..77c6f8211e86 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Update.json new file mode 100644 index 000000000000..835ea88f7057 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Subvolumes_Update.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2023-07-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" + } + } + }, + "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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_Create_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_Create_Oracle.json new file mode 100644 index 000000000000..6cfe75942bf5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/VolumeGroups_Create_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_Create_SapHana.json new file mode 100644 index 000000000000..bda14e9dd9a2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/VolumeGroups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_Delete.json new file mode 100644 index 000000000000..57d4289a65f5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_Get_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_Get_Oracle.json new file mode 100644 index 000000000000..46ea6ccaa2a1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/VolumeGroups_Get_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_Get_SapHana.json new file mode 100644 index 000000000000..50aba876e400 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/VolumeGroups_List_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_List_Oracle.json new file mode 100644 index 000000000000..9e0cbcde4a59 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_List_Oracle.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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/2023-07-01/examples/VolumeGroups_List_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_List_SapHana.json new file mode 100644 index 000000000000..a1f18a22c660 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeGroups_List_SapHana.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2023-07-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/2023-07-01/examples/VolumeQuotaRules_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeQuotaRules_Create.json new file mode 100644 index 000000000000..970897a290f2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-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/2023-07-01/examples/VolumeQuotaRules_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeQuotaRules_Delete.json new file mode 100644 index 000000000000..4cafb09671d5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeQuotaRules_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeQuotaRules_Get.json new file mode 100644 index 000000000000..430b58c037cc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/VolumeQuotaRules_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeQuotaRules_List.json new file mode 100644 index 000000000000..09b559f880e8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/VolumeQuotaRules_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/VolumeQuotaRules_Update.json new file mode 100644 index 000000000000..a7a7961f95a9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..9a528e854a68 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_BreakFileLocks.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_BreakFileLocks.json new file mode 100644 index 000000000000..1f8faac6d153 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..06f369a6cd9f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..936bf4f57640 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_Delete.json new file mode 100644 index 000000000000..8a8fb010f268 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..964ce31bcb4f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_FinalizeRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_FinalizeRelocation.json new file mode 100644 index 000000000000..964ce31bcb4f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_Get.json new file mode 100644 index 000000000000..6899ce630b80 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_List.json new file mode 100644 index 000000000000..5ef1b6567282 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2023-07-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/2023-07-01/examples/Volumes_ListReplications.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ListReplications.json new file mode 100644 index 000000000000..684d2456177f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..3599168fc3b1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_PopulateAvailabilityZones.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_PopulateAvailabilityZones.json new file mode 100644 index 000000000000..9dd21b50a26e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..964ce31bcb4f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ReestablishReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ReestablishReplication.json new file mode 100644 index 000000000000..b829ee5efd41 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_Relocate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_Relocate.json new file mode 100644 index 000000000000..1a831b097acf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..340d054d94c8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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/2023-07-01/examples/Volumes_ResetCifsPassword.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ResetCifsPassword.json new file mode 100644 index 000000000000..964ce31bcb4f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ResetCifsPassword.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_RestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_RestoreStatus.json new file mode 100644 index 000000000000..4afa54f4596d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_RestoreStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2023-07-01" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Uninitialized", + "unhealthyReason": "", + "errorMessage": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..964ce31bcb4f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_Revert.json new file mode 100644 index 000000000000..7fc8e72831b2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_RevertRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_RevertRelocation.json new file mode 100644 index 000000000000..964ce31bcb4f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Volumes_Update.json new file mode 100644 index 000000000000..ecf9e1d84f49 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-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": "2023-07-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=2021-10-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/netapp.json new file mode 100644 index 000000000000..5f8bb2baa3cf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/netapp.json @@ -0,0 +1,8024 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2023-07-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}/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": { + "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_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}/capacityPools/{poolName}/volumes/{volumeName}/restoreStatus": { + "get": { + "tags": [ + "Restore" + ], + "summary": "Get volume's restore status", + "description": "Get the status of the restore for a volume", + "operationId": "Backups_GetVolumeRestoreStatus", + "parameters": [ + { + "$ref": "../../../../../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_RestoreStatus.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": { + "Backups_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": { + "Backups_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" + } + } + } + } + }, + "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" + } + } + }, + "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", + "keyVaultResourceId" + ], + "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." + }, + "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 multiply of 4398046511104).", + "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 multiply of 4398046511104).", + "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. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.", + "minimum": 107374182400, + "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": "UUID v4 or resource identifier used to identify the Snapshot.", + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "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": "UUID v4 or resource identifier used to identify the Backup.", + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "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": { + "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": 7, + "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": { + "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. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.", + "minimum": 107374182400, + "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" + ] + } + } + }, + "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": { + "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": 7, + "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" + }, + "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, some such" + } + } + }, + "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" + } + }, + "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" + } + } +} diff --git a/specification/netapp/resource-manager/readme.go.md b/specification/netapp/resource-manager/readme.go.md index 59e20df0c80f..68cfb88137c4 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-netapp-2023-07-01 + - tag: package-preview-2023-05 - tag: package-netapp-2023-05-01 - tag: package-netapp-2022-11-01-preview - tag: package-netapp-2022-11-01 @@ -40,8 +42,8 @@ batch: - tag: package-netapp-2020-08-01 - tag: package-netapp-2020-07-01 - tag: package-netapp-2020-06-01 - - tag: package-netapp-2020-05-01 - - tag: package-netapp-2020-03-01 + - tag: package-netapp-2020-05-01 + - tag: package-netapp-2020-03-01 - tag: package-netapp-2020-02-01 - tag: package-netapp-2019-11-01 - tag: package-netapp-2019-10-01 @@ -52,6 +54,24 @@ batch: - tag: package-2017-08-15 ``` +### Tag: package-netapp-2023-07-01 and go + +These settings apply only when `--tag=package-netapp-2023-07-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-netapp-2023-07-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2023-07-01/$(namespace) +``` + +### Tag: package-preview-2023-05 and go + +These settings apply only when `--tag=package-preview-2023-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-preview-2023-05' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2023-05-01-preview/$(namespace) +``` + ### Tag: package-netapp-2023-05-01 and go These settings apply only when `--tag=package-netapp-2023-05-01 --go` is specified on the command line. @@ -210,7 +230,7 @@ These settings apply only when `--tag=package-netapp-2020-07-01 --go` is specifi Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-netapp-2020-07-01' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-07-01/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-07-01/$(namespace) ``` ### Tag: package-netapp-2020-06-01 and go @@ -219,7 +239,7 @@ These settings apply only when `--tag=package-netapp-2020-06-01 --go` is specifi Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-netapp-2020-06-01' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-01/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-01/$(namespace) ``` ### Tag: package-netapp-2020-05-01 and go diff --git a/specification/netapp/resource-manager/readme.java.md b/specification/netapp/resource-manager/readme.java.md index 214741f735e6..03a18d629f56 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-netapp-2023-07-01 + - tag: package-preview-2023-05 - tag: package-netapp-2023-05-01 - tag: package-netapp-2022-11-01-preview - tag: package-netapp-2022-11-01 @@ -33,12 +35,12 @@ batch: - tag: package-netapp-2021-02-01 - tag: package-netapp-2020-12-01 - tag: package-netapp-2020-11-01 - - tag: package-netapp-2020-09-01 + - tag: package-netapp-2020-09-01 - tag: package-netapp-2020-08-01 - tag: package-netapp-2020-07-01 - tag: package-netapp-2020-06-01 - - tag: package-netapp-2020-05-01 - - tag: package-netapp-2020-03-01 + - tag: package-netapp-2020-05-01 + - tag: package-netapp-2020-03-01 - tag: package-netapp-2020-02-01 - tag: package-netapp-2019-11-01 - tag: package-netapp-2019-10-01 @@ -49,6 +51,32 @@ batch: - tag: package-2017-08-15 ``` +### Tag: package-netapp-2023-07-01 and java + +These settings apply only when `--tag=package-netapp-2023-07-01 --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-netapp-2023-07-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.netapp.v2023_07_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/netapp/mgmt-v2023_07_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-preview-2023-05 and java + +These settings apply only when `--tag=package-preview-2023-05 --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-preview-2023-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.netapp.v2023_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/netapp/mgmt-v2023_05_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-netapp-2023-05-01 and java These settings apply only when `--tag=package-netapp-2023-05-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 70799183251c..29ca82dfae8d 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-netapp-2023-05-01 +tag: package-netapp-2023-07-01 +``` + +### Tag: package-netapp-2023-07-01 + +These settings apply only when `--tag=package-netapp-2023-07-01` is specified on the command line. + +```yaml $(tag) == 'package-netapp-2023-07-01' +input-file: + - Microsoft.NetApp/stable/2023-07-01/netapp.json +``` + +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - Microsoft.NetApp/preview/2023-05-01-preview/netapp.json ``` @@ -36,10 +54,11 @@ tag: package-netapp-2023-05-01 These settings apply only when `--tag=package-netapp-2023-05-01` is specified on the command line. -```yaml $(tag) == 'package-netapp-2023-05-01' +``` yaml $(tag) == 'package-netapp-2023-05-01' input-file: - Microsoft.NetApp/stable/2023-05-01/netapp.json ``` + ### Tag: package-netapp-2022-11-01 These settings apply only when `--tag=package-netapp-2022-11-01` is specified on the command line. @@ -58,7 +77,6 @@ input-file: - Microsoft.NetApp/preview/2022-11-01-preview/netapp.json ``` - ### Tag: package-netapp-2022-09-01 These settings apply only when `--tag=package-netapp-2022-09-01` is specified on the command line. @@ -309,7 +327,7 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-go - repo: azure-sdk-for-java - - repo: azure-sdk-for-trenton + - repo: azure-sdk-for-trenton - repo: azure-resource-manager-schemas - repo: azure-powershell ``` @@ -358,6 +376,6 @@ suppressions: from: netapp.json where: - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles"].post - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups"].post + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups"].post - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups"].post ``` diff --git a/specification/network/resource-manager/readme.python.md b/specification/network/resource-manager/readme.python.md index ce776c92c5d8..555c132b829e 100644 --- a/specification/network/resource-manager/readme.python.md +++ b/specification/network/resource-manager/readme.python.md @@ -18,9 +18,10 @@ Generate all API versions currently shipped for this package ```yaml $(python) multiapi: true -default-api-version: "2023-05-01" +default-api-version: "2023-06-01" clear-output-folder: true batch: + - tag: package-2023-06 - tag: package-2023-05 - tag: package-2023-04 - tag: package-2023-02 @@ -56,6 +57,16 @@ perform-load: false clear-output-folder: false ``` +### Tag: package-2023-06 and python + +These settings apply only when `--tag=package-2023-06 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2023-06' +namespace: azure.mgmt.network.v2023_06_01 +output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2023_06_01 +``` + ### Tag: package-2023-05 and python These settings apply only when `--tag=package-2023-05 --python` is specified on the command line. diff --git a/specification/networkanalytics/resource-manager/readme.java.md b/specification/networkanalytics/resource-manager/readme.java.md new file mode 100644 index 000000000000..f04c0c55e721 --- /dev/null +++ b/specification/networkanalytics/resource-manager/readme.java.md @@ -0,0 +1,9 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +title: NetworkAnalyticsMgmtClient +service-name: Network Analytics +client-flattened-annotation-target: disabled +``` diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Delete.json deleted file mode 100644 index 07df57637b2d..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Delete.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "bareMetalMachineKeySetName": "bareMetalMachineKeySetName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_ListByResourceGroup.json deleted file mode 100644 index 1550c753b921..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_ListByResourceGroup.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", - "name": "bareMetalMachineKeySetName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "privilegeLevel": "Standard", - "expiration": "2022-12-31T23:59:59.008Z", - "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", - "osGroupName": "standardAccessGroup", - "jumpHostsAllowed": [ - "192.0.2.1", - "192.0.2.5" - ], - "userList": [ - { - "azureUserName": "userABC", - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "description": "Needs access for troubleshooting as a part of the support team" - }, - { - "azureUserName": "userXYZ", - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "description": "Needs access for troubleshooting as a part of the support team" - } - ], - "provisioningState": "Succeeded", - "userListStatus": [ - { - "azureUserName": "userABC", - "status": "Active", - "statusMessage": "User has been provisioned" - }, - { - "azureUserName": "userXYZ", - "status": "Invalid", - "statusMessage": "User is not a valid Azure user" - } - ], - "lastValidation": "2022-12-12T12:00:00.008Z", - "detailedStatus": "SomeInvalid", - "detailedStatusMessage": "Inalid Azure user(s) were provided: userXYZ" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Cordon.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Cordon.json deleted file mode 100644 index d7f67db12495..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Cordon.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName", - "bareMetalMachineCordonParameters": { - "evacuate": "True" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Create.json deleted file mode 100644 index 931541eb06a0..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Create.json +++ /dev/null @@ -1,183 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName", - "bareMetalMachineParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "machineSkuId": "684E-3B16-399E", - "rackSlot": 1, - "machineName": "r01c001", - "bootMacAddress": "00:00:4e:00:58:af", - "bmcMacAddress": "00:00:4f:00:57:00", - "bmcCredentials": { - "username": "bmcuser", - "password": "{password}" - }, - "bmcConnectionString": "bmcconnectionstring", - "machineDetails": "User-provided machine details.", - "serialNumber": "BM1219XXX" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "name": "bareMetalMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/bareMetalMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "machineSkuId": "684E-3B16-399E", - "rackSlot": 1, - "machineName": "r01c001", - "bootMacAddress": "00:00:4e:00:58:af", - "bmcMacAddress": "00:00:4f:00:57:00", - "bmcCredentials": { - "username": "bmcuser" - }, - "bmcConnectionString": "bmcconnectionstring", - "machineDetails": "User-provided machine details.", - "serialNumber": "BM1219XXX", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "readyState": "True", - "cordonStatus": "Uncordoned", - "powerState": "On", - "hardwareInventory": { - "interfaces": [ - { - "name": "networkInterfaceName", - "macAddress": "2C:54:91:88:C9:E3", - "linkStatus": "Up", - "networkInterfaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" - } - ], - "additionalHostInformation": "Machine specific information..." - }, - "detailedStatus": "Available", - "detailedStatusMessage": "DetailedStatusMessage", - "serviceTag": "ST1219XXX", - "kubernetesNodeName": "node01", - "kubernetesVersion": "1.21", - "osImage": "v20220805e", - "oamIpv4Address": "192.0.2.1", - "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", - "hardwareValidationStatus": { - "result": "Pass", - "lastValidationTime": "2022-09-30T13:27:03.008Z" - }, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ] - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "name": "bareMetalMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/bareMetalMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "machineSkuId": "684E-3B16-399E", - "rackSlot": 1, - "machineName": "r01c001", - "bootMacAddress": "00:00:4e:00:58:af", - "bmcMacAddress": "00:00:4f:00:57:00", - "bmcCredentials": { - "username": "bmcuser" - }, - "bmcConnectionString": "bmcconnectionstring", - "machineDetails": "User-provided machine details.", - "serialNumber": "BM1219XXX", - "provisioningState": "Accepted", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "readyState": "True", - "cordonStatus": "Uncordoned", - "powerState": "On", - "hardwareInventory": { - "interfaces": [ - { - "name": "networkInterfaceName", - "macAddress": "2C:54:91:88:C9:E3", - "linkStatus": "Up", - "networkInterfaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" - } - ], - "additionalHostInformation": "Machine specific information..." - }, - "detailedStatus": "Available", - "detailedStatusMessage": "DetailedStatusMessage", - "serviceTag": "ST1219XXX", - "kubernetesNodeName": "node01", - "kubernetesVersion": "1.21", - "osImage": "v20220805e", - "oamIpv4Address": "192.0.2.1", - "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", - "hardwareValidationStatus": { - "result": "Pass", - "lastValidationTime": "2022-09-30T13:27:03.008Z" - }, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ] - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Delete.json deleted file mode 100644 index 4687beb54c3b..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Get.json deleted file mode 100644 index 6742fcf18a6a..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Get.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "name": "bareMetalMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/bareMetalMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "machineSkuId": "684E-3B16-399E", - "rackSlot": 1, - "machineName": "r01c001", - "bootMacAddress": "00:00:4e:00:58:af", - "bmcMacAddress": "00:00:4f:00:57:00", - "bmcCredentials": { - "username": "bmcuser" - }, - "bmcConnectionString": "bmcconnectionstring", - "machineDetails": "User-provided machine details.", - "serialNumber": "BM1219XXX", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "readyState": "True", - "cordonStatus": "Uncordoned", - "powerState": "On", - "hardwareInventory": { - "interfaces": [ - { - "name": "networkInterfaceName", - "macAddress": "2C:54:91:88:C9:E3", - "linkStatus": "Up", - "networkInterfaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" - } - ], - "additionalHostInformation": "Machine specific information..." - }, - "detailedStatus": "Available", - "detailedStatusMessage": "DetailedStatusMessage", - "serviceTag": "ST1219XXX", - "kubernetesNodeName": "node01", - "kubernetesVersion": "1.21", - "osImage": "v20220805e", - "oamIpv4Address": "192.0.2.1", - "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", - "hardwareValidationStatus": { - "result": "Pass", - "lastValidationTime": "2022-09-30T13:27:03.008Z" - }, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ] - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_ListByResourceGroup.json deleted file mode 100644 index ec65a34ab3db..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_ListByResourceGroup.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "name": "bareMetalMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/bareMetalMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "machineSkuId": "684E-3B16-399E", - "rackSlot": 1, - "machineName": "r01c001", - "bootMacAddress": "00:00:4e:00:58:af", - "bmcMacAddress": "00:00:4f:00:57:00", - "bmcCredentials": { - "username": "bmcuser" - }, - "bmcConnectionString": "bmcconnectionstring", - "machineDetails": "User-provided machine details.", - "serialNumber": "BM1219XXX", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "readyState": "True", - "cordonStatus": "Uncordoned", - "powerState": "On", - "hardwareInventory": { - "interfaces": [ - { - "name": "networkInterfaceName", - "macAddress": "2C:54:91:88:C9:E3", - "linkStatus": "Up", - "networkInterfaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" - } - ], - "additionalHostInformation": "Machine specific information..." - }, - "detailedStatus": "Available", - "detailedStatusMessage": "DetailedStatusMessage", - "serviceTag": "ST1219XXX", - "kubernetesNodeName": "node01", - "kubernetesVersion": "1.21", - "osImage": "v20220805e", - "oamIpv4Address": "192.0.2.1", - "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", - "hardwareValidationStatus": { - "result": "Pass", - "lastValidationTime": "2022-09-30T13:27:03.008Z" - }, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ] - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_ListBySubscription.json deleted file mode 100644 index f75963a3a0a1..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_ListBySubscription.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "name": "bareMetalMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/bareMetalMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "machineSkuId": "684E-3B16-399E", - "rackSlot": 1, - "machineName": "r01c001", - "bootMacAddress": "00:00:4e:00:58:af", - "bmcMacAddress": "00:00:4f:00:57:00", - "bmcCredentials": { - "username": "bmcuser" - }, - "bmcConnectionString": "bmcconnectionstring", - "machineDetails": "User-provided machine details.", - "serialNumber": "BM1219XXX", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "readyState": "True", - "cordonStatus": "Uncordoned", - "powerState": "On", - "hardwareInventory": { - "interfaces": [ - { - "name": "networkInterfaceName", - "macAddress": "2C:54:91:88:C9:E3", - "linkStatus": "Up", - "networkInterfaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" - } - ], - "additionalHostInformation": "Machine specific information..." - }, - "detailedStatus": "Available", - "detailedStatusMessage": "DetailedStatusMessage", - "serviceTag": "ST1219XXX", - "kubernetesNodeName": "node01", - "kubernetesVersion": "1.21", - "osImage": "v20220805e", - "oamIpv4Address": "192.0.2.1", - "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", - "hardwareValidationStatus": { - "result": "Pass", - "lastValidationTime": "2022-09-30T13:27:03.008Z" - }, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ] - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Patch.json deleted file mode 100644 index b674f4f230ab..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Patch.json +++ /dev/null @@ -1,166 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName", - "bareMetalMachineUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "machineDetails": "machinedetails" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "name": "bareMetalMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/bareMetalMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "machineSkuId": "684E-3B16-399E", - "rackSlot": 1, - "machineName": "r01c001", - "bootMacAddress": "00:00:4e:00:58:af", - "bmcMacAddress": "00:00:4f:00:57:00", - "bmcCredentials": { - "username": "bmcuser" - }, - "bmcConnectionString": "bmcconnectionstring", - "machineDetails": "User-provided machine details.", - "serialNumber": "BM1219XXX", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "readyState": "True", - "cordonStatus": "Uncordoned", - "powerState": "On", - "hardwareInventory": { - "interfaces": [ - { - "name": "networkInterfaceName", - "macAddress": "2C:54:91:88:C9:E3", - "linkStatus": "Up", - "networkInterfaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" - } - ], - "additionalHostInformation": "Machine specific information..." - }, - "detailedStatus": "Available", - "detailedStatusMessage": "DetailedStatusMessage", - "serviceTag": "ST1219XXX", - "kubernetesNodeName": "node01", - "kubernetesVersion": "1.21", - "osImage": "v20220805e", - "oamIpv4Address": "192.0.2.1", - "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", - "hardwareValidationStatus": { - "result": "Pass", - "lastValidationTime": "2022-09-30T13:27:03.008Z" - }, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ] - } - } - }, - "202": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "name": "bareMetalMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/bareMetalMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "machineSkuId": "684E-3B16-399E", - "rackSlot": 1, - "machineName": "r01c001", - "bootMacAddress": "00:00:4e:00:58:af", - "bmcMacAddress": "00:00:4f:00:57:00", - "bmcCredentials": { - "username": "bmcuser" - }, - "bmcConnectionString": "bmcconnectionstring", - "machineDetails": "User-provided machine details.", - "serialNumber": "BM1219XXX", - "provisioningState": "Accepted", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "readyState": "True", - "cordonStatus": "Uncordoned", - "powerState": "On", - "hardwareInventory": { - "interfaces": [ - { - "name": "networkInterfaceName", - "macAddress": "2C:54:91:88:C9:E3", - "linkStatus": "Up", - "networkInterfaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" - } - ], - "additionalHostInformation": "Machine specific information..." - }, - "detailedStatus": "Available", - "detailedStatusMessage": "DetailedStatusMessage", - "serviceTag": "ST1219XXX", - "kubernetesNodeName": "node01", - "kubernetesVersion": "1.21", - "osImage": "v20220805e", - "oamIpv4Address": "192.0.2.1", - "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", - "hardwareValidationStatus": { - "result": "Pass", - "lastValidationTime": "2022-09-30T13:27:03.008Z" - }, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ] - } - }, - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_PowerOff.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_PowerOff.json deleted file mode 100644 index 823c24fd16c4..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_PowerOff.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName", - "bareMetalMachinePowerOffParameters": { - "skipShutdown": "True" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Reimage.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Reimage.json deleted file mode 100644 index 04c1faa37b9f..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Reimage.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Replace.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Replace.json deleted file mode 100644 index a34410dbae9f..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Replace.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName", - "bareMetalMachineReplaceParameters": { - "bootMacAddress": "00:00:4e:00:58:af", - "bmcCredentials": { - "username": "bmcuser", - "password": "{password}" - }, - "serialNumber": "BM1219XXX", - "bmcMacAddress": "00:00:4f:00:57:ad", - "machineName": "name" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Restart.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Restart.json deleted file mode 100644 index 04c1faa37b9f..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Restart.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_RunCommand.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_RunCommand.json deleted file mode 100644 index 9bdf6be5ae48..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_RunCommand.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName", - "bareMetalMachineRunCommandParameters": { - "script": "cHdkCg==", - "arguments": [ - "--argument1", - "argument2" - ], - "limitTimeSeconds": 60 - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_RunDataExtracts.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_RunDataExtracts.json deleted file mode 100644 index 1575f2288841..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_RunDataExtracts.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName", - "bareMetalMachineRunDataExtractsParameters": { - "commands": [ - { - "command": "networkInfo" - } - ], - "limitTimeSeconds": 60 - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_RunReadCommands.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_RunReadCommands.json deleted file mode 100644 index 61a25c8e4c02..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_RunReadCommands.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName", - "bareMetalMachineRunReadCommandsParameters": { - "commands": [ - { - "command": "kubectl get", - "arguments": [ - "pods", - "-A" - ] - }, - { - "command": "ping", - "arguments": [ - "192.168.0.99", - "-c", - "3" - ] - } - ], - "limitTimeSeconds": 60 - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Start.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Start.json deleted file mode 100644 index 04c1faa37b9f..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Start.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Uncordon.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Uncordon.json deleted file mode 100644 index 04c1faa37b9f..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_Uncordon.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_ValidateHardware.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_ValidateHardware.json deleted file mode 100644 index 4db46fc99d6b..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachines_ValidateHardware.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "bareMetalMachineName": "bareMetalMachineName", - "bareMetalMachineValidateHardwareParameters": { - "validationCategory": "BasicValidation" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Delete.json deleted file mode 100644 index 43e7a2e7c3da..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Delete.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "bmcKeySetName": "bmcKeySetName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_ListByResourceGroup.json deleted file mode 100644 index cbb95361ea91..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_ListByResourceGroup.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", - "name": "bmcKeySetName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "privilegeLevel": "Administrator", - "expiration": "2022-12-31T23:59:59.008Z", - "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", - "userList": [ - { - "azureUserName": "userABC", - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "description": "Needs access for troubleshooting as a part of the support team" - }, - { - "azureUserName": "userXYZ", - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "description": "Needs access for troubleshooting as a part of the support team" - } - ], - "provisioningState": "Succeeded", - "userListStatus": [ - { - "azureUserName": "userABC", - "status": "Active", - "statusMessage": "User has been provisioned" - }, - { - "azureUserName": "userXYZ", - "status": "Invalid", - "statusMessage": "User is not a valid Azure user" - } - ], - "lastValidation": "2022-12-12T12:00:00.008Z", - "detailedStatus": "SomeInvalid", - "detailedStatusMessage": "Inalid Azure user(s) were provided: userXYZ" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Create.json deleted file mode 100644 index 86000dca9065..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Create.json +++ /dev/null @@ -1,158 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "cloudServicesNetworkName": "cloudServicesNetworkName", - "cloudServicesNetworkParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "additionalEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "enableDefaultEgressEndpoints": "False" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "name": "cloudServicesNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/cloudServicesNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "additionalEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "enableDefaultEgressEndpoints": "False", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "enabledEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Cloud services network is up" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "name": "cloudServicesNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/cloudServicesNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "additionalEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "enableDefaultEgressEndpoints": "False", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "enabledEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Cloud services network is up" - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Delete.json deleted file mode 100644 index 302b5c800f36..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "cloudServicesNetworkName": "cloudServicesNetworkName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Get.json deleted file mode 100644 index 61b41b3ac98c..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Get.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "cloudServicesNetworkName": "cloudServicesNetworkName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "name": "cloudServicesNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/cloudServicesNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "additionalEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "enableDefaultEgressEndpoints": "False", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "enabledEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Cloud services network is up" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_ListByResourceGroup.json deleted file mode 100644 index 9f2aed659ae8..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_ListByResourceGroup.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "name": "cloudServicesNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/cloudServicesNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "additionalEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "enableDefaultEgressEndpoints": "False", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "enabledEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Cloud services network is up" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_ListBySubscription.json deleted file mode 100644 index 601bebe0d47a..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_ListBySubscription.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "name": "cloudServicesNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/cloudServicesNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "additionalEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "enableDefaultEgressEndpoints": "False", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "enabledEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Cloud services network is up" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Patch.json deleted file mode 100644 index c9f8b26a8c13..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/CloudServicesNetworks_Patch.json +++ /dev/null @@ -1,153 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "cloudServicesNetworkName": "cloudServicesNetworkName", - "cloudServicesNetworkUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "additionalEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "enableDefaultEgressEndpoints": "False" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "name": "cloudServicesNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/cloudServicesNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "additionalEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "enableDefaultEgressEndpoints": "False", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "enabledEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Cloud services network is up" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "name": "cloudServicesNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/cloudServicesNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "additionalEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "enableDefaultEgressEndpoints": "False", - "provisioningState": "Accepted", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "enabledEgressEndpoints": [ - { - "category": "azure-resource-management", - "endpoints": [ - { - "domainName": "https://storageaccountex.blob.core.windows.net", - "port": 443 - } - ] - } - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Cloud services network is up" - } - }, - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Create.json deleted file mode 100644 index 074e10b7b0d5..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Create.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterManagerName": "clusterManagerName", - "clusterManagerParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "fabricControllerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "name": "clusterManagerName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusterManagers", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "managerExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "fabricControllerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterVersions": [ - { - "targetClusterVersion": "1.0.0", - "supportExpiryDate": "2023-04-29" - }, - { - "targetClusterVersion": "1.0.2", - "supportExpiryDate": "2025-01-01" - } - ], - "provisioningState": "Succeeded", - "detailedStatus": "Available", - "detailedStatusMessage": "cluster manager is up and running", - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - } - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "name": "clusterManagerName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusterManagers", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "managerExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "fabricControllerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterVersions": [ - { - "targetClusterVersion": "1.0.0", - "supportExpiryDate": "2023-04-29" - }, - { - "targetClusterVersion": "1.0.2", - "supportExpiryDate": "2025-01-01" - } - ], - "provisioningState": "Accepted", - "detailedStatus": "Available", - "detailedStatusMessage": "cluster manager is up and running", - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - } - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Delete.json deleted file mode 100644 index 82d4ebb1abe8..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterManagerName": "clusterManagerName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Get.json deleted file mode 100644 index 9b54cff7052e..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Get.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterManagerName": "clusterManagerName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "name": "clusterManagerName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusterManagers", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "managerExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "fabricControllerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterVersions": [ - { - "targetClusterVersion": "1.0.0", - "supportExpiryDate": "2023-04-29" - }, - { - "targetClusterVersion": "1.0.2", - "supportExpiryDate": "2025-01-01" - } - ], - "provisioningState": "Succeeded", - "detailedStatus": "Available", - "detailedStatusMessage": "cluster manager is up and running", - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - } - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_ListByResourceGroup.json deleted file mode 100644 index 86c9fc0b0070..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_ListByResourceGroup.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "name": "clusterManagerName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusterManagers", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "managerExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "fabricControllerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterVersions": [ - { - "targetClusterVersion": "1.0.0", - "supportExpiryDate": "2023-04-29" - }, - { - "targetClusterVersion": "1.0.2", - "supportExpiryDate": "2025-01-01" - } - ], - "provisioningState": "Succeeded", - "detailedStatus": "Available", - "detailedStatusMessage": "cluster manager is up and running", - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - } - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_ListBySubscription.json deleted file mode 100644 index 6f75a91c94af..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_ListBySubscription.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "name": "clusterManagerName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusterManagers", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "managerExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "fabricControllerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterVersions": [ - { - "targetClusterVersion": "1.0.0", - "supportExpiryDate": "2023-04-29" - }, - { - "targetClusterVersion": "1.0.2", - "supportExpiryDate": "2025-01-01" - } - ], - "provisioningState": "Succeeded", - "detailedStatus": "Available", - "detailedStatusMessage": "cluster manager is up and running", - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - } - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Patch.json deleted file mode 100644 index 1a0bb6594907..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterManagers_Patch.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterManagerName": "clusterManagerName", - "clusterManagerUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "name": "clusterManagerName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusterManagers", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "managerExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "fabricControllerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterVersions": [ - { - "targetClusterVersion": "1.0.0", - "supportExpiryDate": "2023-04-29" - }, - { - "targetClusterVersion": "1.0.2", - "supportExpiryDate": "2025-01-01" - } - ], - "provisioningState": "Succeeded", - "detailedStatus": "Available", - "detailedStatusMessage": "cluster manager is up and running", - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - } - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Delete.json deleted file mode 100644 index 57242398fe46..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Delete.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "metricsConfigurationName": "default" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Get.json deleted file mode 100644 index f18381a50fb5..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Get.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "metricsConfigurationName": "default" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "enabledMetrics": [ - "metric1", - "metric2" - ], - "collectionInterval": 15, - "provisioningState": "Succeeded", - "disabledMetrics": [ - "metric3", - "metric4" - ], - "detailedStatus": "Applied", - "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_ListByResourceGroup.json deleted file mode 100644 index d5e8a955550f..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_ListByResourceGroup.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "enabledMetrics": [ - "metric1", - "metric2" - ], - "collectionInterval": 15, - "provisioningState": "Succeeded", - "disabledMetrics": [ - "metric3", - "metric4" - ], - "detailedStatus": "Applied", - "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Patch.json deleted file mode 100644 index b87bd2e60680..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Patch.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "metricsConfigurationName": "default", - "metricsConfigurationUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "enabledMetrics": [ - "metric1", - "metric2" - ], - "collectionInterval": 15 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "enabledMetrics": [ - "metric1", - "metric2" - ], - "collectionInterval": 15, - "provisioningState": "Succeeded", - "disabledMetrics": [ - "metric3", - "metric4" - ], - "detailedStatus": "Applied", - "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." - } - } - }, - "202": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "enabledMetrics": [ - "metric1", - "metric2" - ], - "collectionInterval": 15, - "provisioningState": "Accepted", - "disabledMetrics": [ - "metric3", - "metric4" - ], - "detailedStatus": "Applied", - "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." - } - }, - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Update.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Update.json deleted file mode 100644 index ddfb9b0e6bfd..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/ClusterMetricsConfigurations_Update.json +++ /dev/null @@ -1,108 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "metricsConfigurationName": "default", - "metricsConfigurationParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "enabledMetrics": [ - "metric1", - "metric2" - ], - "collectionInterval": 15 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "enabledMetrics": [ - "metric1", - "metric2" - ], - "collectionInterval": 15, - "provisioningState": "Succeeded", - "disabledMetrics": [ - "metric3", - "metric4" - ], - "detailedStatus": "Applied", - "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "enabledMetrics": [ - "metric1", - "metric2" - ], - "collectionInterval": 15, - "provisioningState": "Accepted", - "disabledMetrics": [ - "metric3", - "metric4" - ], - "detailedStatus": "Applied", - "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Create.json deleted file mode 100644 index 48c6f28fad82..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Create.json +++ /dev/null @@ -1,474 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "clusterParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "networkFabricId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", - "clusterType": "SingleRack", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterLocation": "Foo Street, 3rd Floor, row 9", - "clusterVersion": "1.0.0", - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username", - "password": "{password}" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username", - "password": "{password}" - }, - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username", - "password": "{password}" - }, - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeRackDefinitions": [ - { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username", - "password": "{password}" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username", - "password": "{password}" - }, - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username", - "password": "{password}" - }, - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - } - ], - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - }, - "clusterServicePrincipal": { - "tenantId": "80000000-4000-4000-4000-120000000000", - "principalId": "00000008-0004-0004-0004-000000000012", - "applicationId": "12345678-1234-1234-1234-123456789012", - "password": "{password}" - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "name": "clusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "networkFabricId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", - "clusterType": "SingleRack", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterLocation": "Foo Street, 3rd Floor, row 9", - "clusterVersion": "1.0.0", - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeRackDefinitions": [ - { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - } - ], - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - }, - "clusterServicePrincipal": { - "tenantId": "80000000-4000-4000-4000-120000000000", - "principalId": "00000008-0004-0004-0004-000000000012", - "applicationId": "12345678-1234-1234-1234-123456789012" - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - }, - "provisioningState": "Succeeded", - "clusterExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "hybridAksExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/hybridAKSExtendedLocationName" - }, - "clusterManagerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "availableUpgradeVersions": [ - { - "targetClusterVersion": "1.0.2", - "expectedDuration": "0:0:30", - "controlImpact": "False", - "workloadImpact": "False", - "impactDescription": "can be done in place", - "supportExpiryDate": "2025-01-01" - } - ], - "supportExpiryDate": "2023-04-29", - "detailedStatus": "Running", - "detailedStatusMessage": "Cluster is running and healthy", - "clusterManagerConnectionStatus": "Connected", - "clusterConnectionStatus": "Connected", - "workloadResourceIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" - ], - "clusterCapacity": { - "totalCoreCount": 10, - "availableCoreCount": 10, - "totalMemoryGB": 10, - "availableMemoryGB": 20, - "totalHostStorageGB": 10, - "availableHostStorageGB": 20, - "totalApplianceStorageGB": 10, - "availableApplianceStorageGB": 3 - }, - "manualActionCount": 0 - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "name": "clusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "networkFabricId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", - "clusterType": "SingleRack", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterLocation": "Foo Street, 3rd Floor, row 9", - "clusterVersion": "1.0.0", - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeRackDefinitions": [ - { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - } - ], - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - }, - "clusterServicePrincipal": { - "tenantId": "80000000-4000-4000-4000-120000000000", - "principalId": "00000008-0004-0004-0004-000000000012", - "applicationId": "12345678-1234-1234-1234-123456789012" - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - }, - "provisioningState": "Accepted", - "clusterExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "hybridAksExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/hybridAKSExtendedLocationName" - }, - "clusterManagerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "availableUpgradeVersions": [ - { - "targetClusterVersion": "1.0.2", - "expectedDuration": "0:0:30", - "controlImpact": "False", - "workloadImpact": "False", - "impactDescription": "can be done in place", - "supportExpiryDate": "2025-01-01" - } - ], - "supportExpiryDate": "2023-04-29", - "detailedStatus": "PendingDeployment", - "detailedStatusMessage": "Cluster creation is accepted. Deployment is pending.", - "clusterManagerConnectionStatus": "Connected", - "clusterConnectionStatus": "Connected", - "workloadResourceIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" - ], - "clusterCapacity": { - "totalCoreCount": 10, - "availableCoreCount": 10, - "totalMemoryGB": 10, - "availableMemoryGB": 20, - "totalHostStorageGB": 10, - "availableHostStorageGB": 20, - "totalApplianceStorageGB": 10, - "availableApplianceStorageGB": 3 - }, - "manualActionCount": 0 - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Delete.json deleted file mode 100644 index 2ab45078fa01..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Deploy.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Deploy.json deleted file mode 100644 index 2e272b4d2a79..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Deploy.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "clusterDeployParameters": {} - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Deploy_SkipValidation.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Deploy_SkipValidation.json deleted file mode 100644 index c04408525c6e..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Deploy_SkipValidation.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "clusterDeployParameters": { - "skipValidationsForMachines": [ - "bmmName1" - ] - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Get.json deleted file mode 100644 index 90af700e7967..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Get.json +++ /dev/null @@ -1,180 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "name": "clusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "networkFabricId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", - "clusterType": "SingleRack", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterLocation": "Foo Street, 3rd Floor, row 9", - "clusterVersion": "1.0.0", - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeRackDefinitions": [ - { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - } - ], - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - }, - "clusterServicePrincipal": { - "tenantId": "80000000-4000-4000-4000-120000000000", - "principalId": "00000008-0004-0004-0004-000000000012", - "applicationId": "12345678-1234-1234-1234-123456789012" - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - }, - "provisioningState": "Succeeded", - "clusterExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "hybridAksExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/hybridAKSExtendedLocationName" - }, - "clusterManagerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "availableUpgradeVersions": [ - { - "targetClusterVersion": "1.0.2", - "expectedDuration": "0:0:30", - "controlImpact": "False", - "workloadImpact": "False", - "impactDescription": "can be done in place", - "supportExpiryDate": "2025-01-01" - } - ], - "supportExpiryDate": "2023-04-29", - "detailedStatus": "Running", - "detailedStatusMessage": "Cluster is running and healthy", - "clusterManagerConnectionStatus": "Connected", - "clusterConnectionStatus": "Connected", - "workloadResourceIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" - ], - "clusterCapacity": { - "totalCoreCount": 10, - "availableCoreCount": 10, - "totalMemoryGB": 10, - "availableMemoryGB": 20, - "totalHostStorageGB": 10, - "availableHostStorageGB": 20, - "totalApplianceStorageGB": 10, - "availableApplianceStorageGB": 3 - }, - "manualActionCount": 0 - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_ListByResourceGroup.json deleted file mode 100644 index 6801f6d7b236..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_ListByResourceGroup.json +++ /dev/null @@ -1,184 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "name": "clusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "networkFabricId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", - "clusterType": "SingleRack", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterLocation": "Foo Street, 3rd Floor, row 9", - "clusterVersion": "1.0.0", - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeRackDefinitions": [ - { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - } - ], - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - }, - "clusterServicePrincipal": { - "tenantId": "80000000-4000-4000-4000-120000000000", - "principalId": "00000008-0004-0004-0004-000000000012", - "applicationId": "12345678-1234-1234-1234-123456789012" - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - }, - "provisioningState": "Succeeded", - "clusterExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "hybridAksExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/hybridAKSExtendedLocationName" - }, - "clusterManagerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "availableUpgradeVersions": [ - { - "targetClusterVersion": "1.0.2", - "expectedDuration": "0:0:30", - "controlImpact": "False", - "workloadImpact": "False", - "impactDescription": "can be done in place", - "supportExpiryDate": "2025-01-01" - } - ], - "supportExpiryDate": "2023-04-29", - "detailedStatus": "Running", - "detailedStatusMessage": "Cluster is running and healthy", - "clusterManagerConnectionStatus": "Connected", - "clusterConnectionStatus": "Connected", - "workloadResourceIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" - ], - "clusterCapacity": { - "totalCoreCount": 10, - "availableCoreCount": 10, - "totalMemoryGB": 10, - "availableMemoryGB": 20, - "totalHostStorageGB": 10, - "availableHostStorageGB": 20, - "totalApplianceStorageGB": 10, - "availableApplianceStorageGB": 3 - }, - "manualActionCount": 0 - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_ListBySubscription.json deleted file mode 100644 index bd1a9e04201b..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_ListBySubscription.json +++ /dev/null @@ -1,183 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "name": "clusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "networkFabricId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", - "clusterType": "SingleRack", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterLocation": "Foo Street, 3rd Floor, row 9", - "clusterVersion": "1.0.0", - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeRackDefinitions": [ - { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - } - ], - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - }, - "clusterServicePrincipal": { - "tenantId": "80000000-4000-4000-4000-120000000000", - "principalId": "00000008-0004-0004-0004-000000000012", - "applicationId": "12345678-1234-1234-1234-123456789012" - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - }, - "provisioningState": "Succeeded", - "clusterExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "hybridAksExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/hybridAKSExtendedLocationName" - }, - "clusterManagerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "availableUpgradeVersions": [ - { - "targetClusterVersion": "1.0.2", - "expectedDuration": "0:0:30", - "controlImpact": "False", - "workloadImpact": "False", - "impactDescription": "can be done in place", - "supportExpiryDate": "2025-01-01" - } - ], - "supportExpiryDate": "2023-04-29", - "detailedStatus": "Running", - "detailedStatusMessage": "Cluster is running and healthy", - "clusterManagerConnectionStatus": "Connected", - "clusterConnectionStatus": "Connected", - "workloadResourceIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" - ], - "clusterCapacity": { - "totalCoreCount": 10, - "availableCoreCount": 10, - "totalMemoryGB": 10, - "availableMemoryGB": 20, - "totalHostStorageGB": 10, - "availableHostStorageGB": 20, - "totalApplianceStorageGB": 10, - "availableApplianceStorageGB": 3 - }, - "manualActionCount": 0 - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json deleted file mode 100644 index 1e7d3c4eaf67..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json +++ /dev/null @@ -1,409 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "clusterUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "newSerialNumber", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username", - "password": "{password}" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username", - "password": "{password}" - }, - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username", - "password": "{password}" - }, - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "name": "clusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "networkFabricId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", - "clusterType": "SingleRack", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterLocation": "Foo Street, 3rd Floor, row 9", - "clusterVersion": "1.0.0", - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "newSerialNumber", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeRackDefinitions": [ - { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - } - ], - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - }, - "clusterServicePrincipal": { - "tenantId": "80000000-4000-4000-4000-120000000000", - "principalId": "00000008-0004-0004-0004-000000000012", - "applicationId": "12345678-1234-1234-1234-123456789012" - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - }, - "provisioningState": "Accepted", - "clusterExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "hybridAksExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/hybridAKSExtendedLocationName" - }, - "clusterManagerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "availableUpgradeVersions": [ - { - "targetClusterVersion": "1.0.2", - "expectedDuration": "0:0:30", - "controlImpact": "False", - "workloadImpact": "False", - "impactDescription": "can be done in place", - "supportExpiryDate": "2025-01-01" - } - ], - "supportExpiryDate": "2023-04-29", - "detailedStatus": "Running", - "detailedStatusMessage": "Cluster is running and healthy", - "clusterManagerConnectionStatus": "Connected", - "clusterConnectionStatus": "Connected", - "workloadResourceIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" - ], - "clusterCapacity": { - "totalCoreCount": 10, - "availableCoreCount": 10, - "totalMemoryGB": 10, - "availableMemoryGB": 20, - "totalHostStorageGB": 10, - "availableHostStorageGB": 20, - "totalApplianceStorageGB": 10, - "availableApplianceStorageGB": 3 - }, - "manualActionCount": 0 - } - } - }, - "202": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "name": "clusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "networkFabricId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", - "clusterType": "SingleRack", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterLocation": "Foo Street, 3rd Floor, row 9", - "clusterVersion": "1.0.0", - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "newSerialNumber", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeRackDefinitions": [ - { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - } - ], - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - }, - "clusterServicePrincipal": { - "tenantId": "80000000-4000-4000-4000-120000000000", - "principalId": "00000008-0004-0004-0004-000000000012", - "applicationId": "12345678-1234-1234-1234-123456789012" - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - }, - "provisioningState": "Accepted", - "clusterExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "hybridAksExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/hybridAKSExtendedLocationName" - }, - "clusterManagerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "availableUpgradeVersions": [ - { - "targetClusterVersion": "1.0.2", - "expectedDuration": "0:0:30", - "controlImpact": "False", - "workloadImpact": "False", - "impactDescription": "can be done in place", - "supportExpiryDate": "2025-01-01" - } - ], - "supportExpiryDate": "2023-04-29", - "detailedStatus": "Running", - "detailedStatusMessage": "Cluster is running and healthy", - "clusterManagerConnectionStatus": "Connected", - "clusterConnectionStatus": "Connected", - "workloadResourceIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" - ], - "clusterCapacity": { - "totalCoreCount": 10, - "availableCoreCount": 10, - "totalMemoryGB": 10, - "availableMemoryGB": 20, - "totalHostStorageGB": 10, - "availableHostStorageGB": 20, - "totalApplianceStorageGB": 10, - "availableApplianceStorageGB": 3 - }, - "manualActionCount": 0 - } - }, - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Patch_Location.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Patch_Location.json deleted file mode 100644 index e3694f4b92ff..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_Patch_Location.json +++ /dev/null @@ -1,362 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "clusterUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "clusterLocation": "Foo Street, 3rd Floor, row 9" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "name": "clusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "networkFabricId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", - "clusterType": "SingleRack", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterLocation": "Foo Street, 3rd Floor, row 9", - "clusterVersion": "1.0.0", - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeRackDefinitions": [ - { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - } - ], - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - }, - "clusterServicePrincipal": { - "tenantId": "80000000-4000-4000-4000-120000000000", - "principalId": "00000008-0004-0004-0004-000000000012", - "applicationId": "12345678-1234-1234-1234-123456789012" - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - }, - "provisioningState": "Succeeded", - "clusterExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "hybridAksExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/hybridAKSExtendedLocationName" - }, - "clusterManagerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "availableUpgradeVersions": [ - { - "targetClusterVersion": "1.0.2", - "expectedDuration": "0:0:30", - "controlImpact": "False", - "workloadImpact": "False", - "impactDescription": "can be done in place", - "supportExpiryDate": "2025-01-01" - } - ], - "supportExpiryDate": "2023-04-29", - "detailedStatus": "Running", - "detailedStatusMessage": "Cluster is running and healthy", - "clusterManagerConnectionStatus": "Connected", - "clusterConnectionStatus": "Connected", - "workloadResourceIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" - ], - "clusterCapacity": { - "totalCoreCount": 10, - "availableCoreCount": 10, - "totalMemoryGB": 10, - "availableMemoryGB": 20, - "totalHostStorageGB": 10, - "availableHostStorageGB": 20, - "totalApplianceStorageGB": 10, - "availableApplianceStorageGB": 3 - }, - "manualActionCount": 0 - } - } - }, - "202": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "name": "clusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/clusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "networkFabricId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", - "clusterType": "SingleRack", - "analyticsWorkspaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", - "clusterLocation": "Foo Street, 3rd Floor, row 9", - "clusterVersion": "1.0.0", - "aggregatorOrSingleRackDefinition": { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - }, - "computeRackDefinitions": [ - { - "networkRackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", - "rackSkuId": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", - "rackSerialNumber": "AA1234", - "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", - "storageApplianceConfigurationData": [ - { - "rackSlot": 1, - "adminCredentials": { - "username": "username" - }, - "storageApplianceName": "vmName", - "serialNumber": "BM1219XXX" - } - ], - "bareMetalMachineConfigurationData": [ - { - "rackSlot": 1, - "bootMacAddress": "00:BB:CC:DD:EE:FF", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName1", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:FF", - "serialNumber": "BM1219XXX" - }, - { - "rackSlot": 2, - "bootMacAddress": "00:BB:CC:DD:EE:00", - "bmcCredentials": { - "username": "username" - }, - "bmcConnectionString": "bmcConnectionString", - "machineName": "bmmName2", - "machineDetails": "extraDetails", - "bmcMacAddress": "AA:BB:CC:DD:EE:00", - "serialNumber": "BM1219YYY" - } - ] - } - ], - "managedResourceGroupConfiguration": { - "name": "my-managed-rg", - "location": "East US" - }, - "clusterServicePrincipal": { - "tenantId": "80000000-4000-4000-4000-120000000000", - "principalId": "00000008-0004-0004-0004-000000000012", - "applicationId": "12345678-1234-1234-1234-123456789012" - }, - "computeDeploymentThreshold": { - "type": "PercentSuccess", - "grouping": "PerCluster", - "value": 90 - }, - "provisioningState": "Accepted", - "clusterExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "hybridAksExtendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/hybridAKSExtendedLocationName" - }, - "clusterManagerId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", - "availableUpgradeVersions": [ - { - "targetClusterVersion": "1.0.2", - "expectedDuration": "0:0:30", - "controlImpact": "False", - "workloadImpact": "False", - "impactDescription": "can be done in place", - "supportExpiryDate": "2025-01-01" - } - ], - "supportExpiryDate": "2023-04-29", - "detailedStatus": "Running", - "detailedStatusMessage": "Cluster is running and healthy", - "clusterManagerConnectionStatus": "Connected", - "clusterConnectionStatus": "Connected", - "workloadResourceIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" - ], - "clusterCapacity": { - "totalCoreCount": 10, - "availableCoreCount": 10, - "totalMemoryGB": 10, - "availableMemoryGB": 20, - "totalHostStorageGB": 10, - "availableHostStorageGB": 20, - "totalApplianceStorageGB": 10, - "availableApplianceStorageGB": 3 - }, - "manualActionCount": 0 - } - }, - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_UpdateVersion.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_UpdateVersion.json deleted file mode 100644 index 2a5e76f4325b..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Clusters_UpdateVersion.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "clusterName": "clusterName", - "clusterUpdateVersionParameters": { - "targetClusterVersion": "2.0" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Create.json deleted file mode 100644 index 8c72dffd8666..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Create.json +++ /dev/null @@ -1,104 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName", - "consoleName": "default", - "consoleParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "enabled": "True", - "expiration": "2022-06-01T01:27:03.008Z" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines/consoles", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "enabled": "True", - "expiration": "2022-06-01T01:27:03.008Z", - "provisioningState": "Succeeded", - "privateLinkServiceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", - "virtualMachineAccessId": "VirtualMachineAccessId", - "detailedStatus": "Ready", - "detailedStatusMessage": "Console is ready for use" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines/consoles", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "enabled": "True", - "expiration": "2022-06-01T01:27:03.008Z", - "provisioningState": "Accepted", - "privateLinkServiceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", - "virtualMachineAccessId": "VirtualMachineAccessId", - "detailedStatus": "Ready", - "detailedStatusMessage": "Console is ready for use" - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Delete.json deleted file mode 100644 index ba19bed6f324..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Delete.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName", - "consoleName": "default" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Get.json deleted file mode 100644 index f62c39c51e61..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Get.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName", - "consoleName": "default" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines/consoles", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "enabled": "True", - "expiration": "2022-06-01T01:27:03.008Z", - "provisioningState": "Succeeded", - "privateLinkServiceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", - "virtualMachineAccessId": "VirtualMachineAccessId", - "detailedStatus": "Ready", - "detailedStatusMessage": "Console is ready for use" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_ListByResourceGroup.json deleted file mode 100644 index 49b2a3fe0cfb..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_ListByResourceGroup.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines/consoles", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "enabled": "True", - "expiration": "2022-06-01T01:27:03.008Z", - "provisioningState": "Succeeded", - "privateLinkServiceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", - "virtualMachineAccessId": "VirtualMachineAccessId", - "detailedStatus": "Ready", - "detailedStatusMessage": "Console is ready for use" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Patch.json deleted file mode 100644 index 1818d32194e5..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Consoles_Patch.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName", - "consoleName": "default", - "consoleUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "expiration": "2022-06-01T01:27:03.008Z", - "enabled": "True" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines/consoles", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "enabled": "True", - "expiration": "2022-06-01T01:27:03.008Z", - "provisioningState": "Succeeded", - "privateLinkServiceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", - "virtualMachineAccessId": "VirtualMachineAccessId", - "detailedStatus": "Ready", - "detailedStatusMessage": "Console is ready for use" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", - "name": "default", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines/consoles", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" - }, - "properties": { - "sshPublicKey": { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - }, - "enabled": "True", - "expiration": "2022-06-01T01:27:03.008Z", - "provisioningState": "Accepted", - "privateLinkServiceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", - "virtualMachineAccessId": "VirtualMachineAccessId", - "detailedStatus": "Ready", - "detailedStatusMessage": "Console is ready for use" - } - }, - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Create.json deleted file mode 100644 index 5ec3bfdf02dc..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Create.json +++ /dev/null @@ -1,197 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "defaultCniNetworkName": "defaultCniNetworkName", - "defaultCniNetworkParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "cniBgpConfiguration": { - "serviceExternalPrefixes": [ - "192.0.2.0/28" - ], - "serviceLoadBalancerPrefixes": [ - "192.0.2.16/28" - ], - "communityAdvertisements": [ - { - "subnetPrefix": "192.0.2.0/27", - "communities": [ - "64512:100" - ] - } - ], - "bgpPeers": [ - { - "peerIp": "203.0.113.254", - "asNumber": 64497 - } - ] - }, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "203.0.113.0/24", - "ipv6ConnectedPrefix": "2001:db8:0:3::/64" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultcniNetworks/defaultcniNetworkName", - "name": "defaultcniNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/defaultcniNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "cniBgpConfiguration": { - "serviceExternalPrefixes": [ - "192.0.2.0/28" - ], - "serviceLoadBalancerPrefixes": [ - "192.0.2.16/28" - ], - "communityAdvertisements": [ - { - "subnetPrefix": "192.0.2.0/27", - "communities": [ - "64512:100" - ] - } - ], - "bgpPeers": [ - { - "peerIp": "203.0.113.254", - "asNumber": 64497 - } - ] - }, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "203.0.113.0/24", - "ipv6ConnectedPrefix": "2001:db8:0:3::/64", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "fabricBgpPeers": [ - { - "peerIp": "203.0.113.2", - "asNumber": 64496 - }, - { - "peerIp": "203.0.113.3", - "asNumber": 64496 - } - ], - "cniAsNumber": 64512, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Default CNI network is up" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultcniNetworks/defaultcniNetworkName", - "name": "defaultcniNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/defaultcniNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "cniBgpConfiguration": { - "serviceExternalPrefixes": [ - "192.0.2.0/28" - ], - "serviceLoadBalancerPrefixes": [ - "192.0.2.16/28" - ], - "communityAdvertisements": [ - { - "subnetPrefix": "192.0.2.0/27", - "communities": [ - "64512:100" - ] - } - ], - "bgpPeers": [ - { - "peerIp": "203.0.113.254", - "asNumber": 64497 - } - ] - }, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "203.0.113.0/24", - "ipv6ConnectedPrefix": "2001:db8:0:3::/64", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "fabricBgpPeers": [ - { - "peerIp": "203.0.113.2", - "asNumber": 64496 - }, - { - "peerIp": "203.0.113.3", - "asNumber": 64496 - } - ], - "cniAsNumber": 64512, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Default CNI network is up" - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Delete.json deleted file mode 100644 index 08cebf598d1b..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "defaultCniNetworkName": "defaultCniNetworkName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Get.json deleted file mode 100644 index 0495ede16f7b..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Get.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "defaultCniNetworkName": "defaultCniNetworkName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultcniNetworks/defaultcniNetworkName", - "name": "defaultcniNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/defaultcniNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "cniBgpConfiguration": { - "serviceExternalPrefixes": [ - "192.0.2.0/28" - ], - "serviceLoadBalancerPrefixes": [ - "192.0.2.16/28" - ], - "communityAdvertisements": [ - { - "subnetPrefix": "192.0.2.0/27", - "communities": [ - "64512:100" - ] - } - ], - "bgpPeers": [ - { - "peerIp": "203.0.113.254", - "asNumber": 64497 - } - ] - }, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "203.0.113.0/24", - "ipv6ConnectedPrefix": "2001:db8:0:3::/64", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "fabricBgpPeers": [ - { - "peerIp": "203.0.113.2", - "asNumber": 64496 - }, - { - "peerIp": "203.0.113.3", - "asNumber": 64496 - } - ], - "cniAsNumber": 64512, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Default CNI network is up" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_ListByResourceGroup.json deleted file mode 100644 index 8f5368281978..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_ListByResourceGroup.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultcniNetworks/defaultcniNetworkName", - "name": "defaultcniNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/defaultcniNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "cniBgpConfiguration": { - "serviceExternalPrefixes": [ - "192.0.2.0/28" - ], - "serviceLoadBalancerPrefixes": [ - "192.0.2.16/28" - ], - "communityAdvertisements": [ - { - "subnetPrefix": "192.0.2.0/27", - "communities": [ - "64512:100" - ] - } - ], - "bgpPeers": [ - { - "peerIp": "203.0.113.254", - "asNumber": 64497 - } - ] - }, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "203.0.113.0/24", - "ipv6ConnectedPrefix": "2001:db8:0:3::/64", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "fabricBgpPeers": [ - { - "peerIp": "203.0.113.2", - "asNumber": 64496 - }, - { - "peerIp": "203.0.113.3", - "asNumber": 64496 - } - ], - "cniAsNumber": 64512, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Default CNI network is up" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_ListBySubscription.json deleted file mode 100644 index 269496aa243d..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_ListBySubscription.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultcniNetworks/defaultcniNetworkName", - "name": "defaultcniNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/defaultcniNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "cniBgpConfiguration": { - "serviceExternalPrefixes": [ - "192.0.2.0/28" - ], - "serviceLoadBalancerPrefixes": [ - "192.0.2.16/28" - ], - "communityAdvertisements": [ - { - "subnetPrefix": "192.0.2.0/27", - "communities": [ - "64512:100" - ] - } - ], - "bgpPeers": [ - { - "peerIp": "203.0.113.254", - "asNumber": 64497 - } - ] - }, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "203.0.113.0/24", - "ipv6ConnectedPrefix": "2001:db8:0:3::/64", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "fabricBgpPeers": [ - { - "peerIp": "203.0.113.2", - "asNumber": 64496 - }, - { - "peerIp": "203.0.113.3", - "asNumber": 64496 - } - ], - "cniAsNumber": 64512, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Default CNI network is up" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Patch.json deleted file mode 100644 index 5ae98b4f87fe..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/DefaultCniNetworks_Patch.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "defaultCniNetworkName": "defaultCniNetworkName", - "DefaultCniNetworkUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultcniNetworks/defaultcniNetworkName", - "name": "defaultcniNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/defaultcniNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "cniBgpConfiguration": { - "serviceExternalPrefixes": [ - "192.0.2.0/28" - ], - "serviceLoadBalancerPrefixes": [ - "192.0.2.16/28" - ], - "communityAdvertisements": [ - { - "subnetPrefix": "192.0.2.0/27", - "communities": [ - "64512:100" - ] - } - ], - "bgpPeers": [ - { - "peerIp": "203.0.113.254", - "asNumber": 64497 - } - ] - }, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "203.0.113.0/24", - "ipv6ConnectedPrefix": "2001:db8:0:3::/64", - "provisioningState": "Succeeded", - "interfaceName": "eth0", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "fabricBgpPeers": [ - { - "peerIp": "203.0.113.2", - "asNumber": 64496 - }, - { - "peerIp": "203.0.113.3", - "asNumber": 64496 - } - ], - "cniAsNumber": 64512, - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Default CNI network is up" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Create.json deleted file mode 100644 index 8539b379877e..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Create.json +++ /dev/null @@ -1,596 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "hybridAksClusterName": "hybridAksClusterName", - "hybridAksClusterParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "hybridAksProvisionedClusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/hybridAksClusterName", - "associatedNetworkIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName" - ], - "controlPlaneCount": 4, - "workerCount": 8 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName", - "name": "HybridAksClusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/hybridAksClusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "hybridAksProvisionedClusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/hybridAksClusterName", - "associatedNetworkIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName" - ], - "controlPlaneCount": 4, - "workerCount": 8, - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "cloudServicesNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "defaultCniNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultCniNetworks/defaultCniNetworkName", - "controlPlaneNodes": [ - { - "vmSize": "NC_G2_v1", - "vmCount": 4, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "control0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "workerNodes": [ - { - "nodePoolName": "regularWorkers", - "agentPoolName": "regularWorkers", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/regularWorkers", - "vmSize": "NC_Gr_v1", - "vmCount": 6, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "worker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker4", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker5", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - }, - { - "nodePoolName": "highMemory", - "agentPoolName": "highMemory", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/highMemory", - "vmSize": "NC_Gh_v1", - "vmCount": 2, - "cpuCores": 32, - "memorySizeGB": 128, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "highmemworker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "highmemworker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Hybrid AKS cluster is operational" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName", - "name": "HybridAksClusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/hybridAksClusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "hybridAksProvisionedClusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/hybridAksClusterName", - "associatedNetworkIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName" - ], - "controlPlaneCount": 4, - "workerCount": 8, - "provisioningState": "Accepted", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "cloudServicesNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "defaultCniNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultCniNetworks/defaultCniNetworkName", - "controlPlaneNodes": [ - { - "vmSize": "NC_G2_v1", - "vmCount": 4, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "control0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "workerNodes": [ - { - "nodePoolName": "regularWorkers", - "agentPoolName": "regularWorkers", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/regularWorkers", - "vmSize": "NC_Gr_v1", - "vmCount": 6, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "worker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker4", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker5", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - }, - { - "nodePoolName": "highMemory", - "agentPoolName": "highMemory", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/highMemory", - "vmSize": "NC_Gh_v1", - "vmCount": 2, - "cpuCores": 32, - "memorySizeGB": 128, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "highmemworker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "highmemworker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Hybrid AKS cluster is operational" - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Delete.json deleted file mode 100644 index 636b344bf4b4..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "hybridAksClusterName": "hybridAksClusterName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Get.json deleted file mode 100644 index fa4226fc2b83..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Get.json +++ /dev/null @@ -1,292 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "hybridAksClusterName": "hybridAksClusterName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName", - "name": "HybridAksClusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/hybridAksClusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "hybridAksProvisionedClusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/hybridAksClusterName", - "associatedNetworkIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName" - ], - "controlPlaneCount": 4, - "workerCount": 8, - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "cloudServicesNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "defaultCniNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultCniNetworks/defaultCniNetworkName", - "controlPlaneNodes": [ - { - "vmSize": "NC_G2_v1", - "vmCount": 4, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "control0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "workerNodes": [ - { - "nodePoolName": "regularWorkers", - "agentPoolName": "regularWorkers", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/regularWorkers", - "vmSize": "NC_Gr_v1", - "vmCount": 6, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "worker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker4", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker5", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - }, - { - "nodePoolName": "highMemory", - "agentPoolName": "highMemory", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/highMemory", - "vmSize": "NC_Gh_v1", - "vmCount": 2, - "cpuCores": 32, - "memorySizeGB": 128, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "highmemworker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "highmemworker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Hybrid AKS cluster is operational" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_ListByResourceGroup.json deleted file mode 100644 index cfc29e6c9929..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_ListByResourceGroup.json +++ /dev/null @@ -1,295 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName", - "name": "HybridAksClusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/hybridAksClusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "hybridAksProvisionedClusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/hybridAksClusterName", - "associatedNetworkIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName" - ], - "controlPlaneCount": 4, - "workerCount": 8, - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "cloudServicesNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "defaultCniNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultCniNetworks/defaultCniNetworkName", - "controlPlaneNodes": [ - { - "vmSize": "NC_G2_v1", - "vmCount": 4, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "control0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "workerNodes": [ - { - "nodePoolName": "regularWorkers", - "agentPoolName": "regularWorkers", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/regularWorkers", - "vmSize": "NC_Gr_v1", - "vmCount": 6, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "worker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker4", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker5", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - }, - { - "nodePoolName": "highMemory", - "agentPoolName": "highMemory", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/highMemory", - "vmSize": "NC_Gh_v1", - "vmCount": 2, - "cpuCores": 32, - "memorySizeGB": 128, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "highmemworker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "highmemworker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Hybrid AKS cluster is operational" - } - } - ] - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_ListBySubscription.json deleted file mode 100644 index 39f89dc2e96f..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_ListBySubscription.json +++ /dev/null @@ -1,294 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName", - "name": "HybridAksClusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/hybridAksClusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "hybridAksProvisionedClusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/hybridAksClusterName", - "associatedNetworkIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName" - ], - "controlPlaneCount": 4, - "workerCount": 8, - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "cloudServicesNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "defaultCniNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultCniNetworks/defaultCniNetworkName", - "controlPlaneNodes": [ - { - "vmSize": "NC_G2_v1", - "vmCount": 4, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "control0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "workerNodes": [ - { - "nodePoolName": "regularWorkers", - "agentPoolName": "regularWorkers", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/regularWorkers", - "vmSize": "NC_Gr_v1", - "vmCount": 6, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "worker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker4", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker5", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - }, - { - "nodePoolName": "highMemory", - "agentPoolName": "highMemory", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/highMemory", - "vmSize": "NC_Gh_v1", - "vmCount": 2, - "cpuCores": 32, - "memorySizeGB": 128, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "highmemworker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "highmemworker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Hybrid AKS cluster is operational" - } - } - ] - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Patch.json deleted file mode 100644 index 059cd45e8fd9..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_Patch.json +++ /dev/null @@ -1,298 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "hybridAksClusterName": "hybridAksClusterName", - "hybridAksClusterUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName", - "name": "HybridAksClusterName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/hybridAksClusters", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "hybridAksProvisionedClusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/hybridAksClusterName", - "associatedNetworkIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName" - ], - "controlPlaneCount": 4, - "workerCount": 8, - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "cloudServicesNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "defaultCniNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/defaultCniNetworks/defaultCniNetworkName", - "controlPlaneNodes": [ - { - "vmSize": "NC_G2_v1", - "vmCount": 4, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "control0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "control3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "workerNodes": [ - { - "nodePoolName": "regularWorkers", - "agentPoolName": "regularWorkers", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/regularWorkers", - "vmSize": "NC_Gr_v1", - "vmCount": 6, - "cpuCores": 2, - "memorySizeGB": 8, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "worker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker2", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker3", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker4", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "worker5", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - }, - { - "nodePoolName": "highMemory", - "agentPoolName": "highMemory", - "agentPoolId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.HybridContainerService/provisionedClusters/provisionedClustersName/agentPools/highMemory", - "vmSize": "NC_Gh_v1", - "vmCount": 2, - "cpuCores": 32, - "memorySizeGB": 128, - "diskSizeGB": 128, - "nodes": [ - { - "nodeName": "highmemworker0", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - }, - { - "nodeName": "highmemworker1", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "imageId": "myacr.azurecr.io/worker:latest", - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0001", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ] - } - ] - } - ], - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Hybrid AKS cluster is operational" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_RestartNode.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_RestartNode.json deleted file mode 100644 index 85e77c320672..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/HybridAksClusters_RestartNode.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "hybridAksClusterName": "hybridAksClusterName", - "hybridAksClusterRestartNodeParameters": { - "nodeName": "nodeName" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Create.json deleted file mode 100644 index 0d817efc1f9a..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Create.json +++ /dev/null @@ -1,107 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "l2NetworkName": "l2NetworkName", - "l2NetworkParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l2IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "hybridAksPluginType": "DPDK" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", - "name": "l2NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l2Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l2IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L2 network is up" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", - "name": "l2NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l2Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l2IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L2 network is up" - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Delete.json deleted file mode 100644 index 4c07d0fac2fc..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "l2NetworkName": "l2NetworkName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Get.json deleted file mode 100644 index f96d796e67b0..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Get.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "l2NetworkName": "l2NetworkName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", - "name": "l2NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l2Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l2IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L2 network is up" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_ListByResourceGroup.json deleted file mode 100644 index cc4ab2d3a7fc..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_ListByResourceGroup.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", - "name": "l2NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l2Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l2IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L2 network is up" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_ListBySubscription.json deleted file mode 100644 index 75c1d6b4a0cc..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_ListBySubscription.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", - "name": "l2NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l2Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l2IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L2 network is up" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Patch.json deleted file mode 100644 index 19477a22b7c4..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L2Networks_Patch.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "l2NetworkName": "l2NetworkName", - "l2NetworkUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", - "name": "l2NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l2Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l2IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L2 network is up" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Create.json deleted file mode 100644 index 417c171478c5..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Create.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "l3NetworkName": "l3NetworkName", - "l3NetworkParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "198.51.100.0/24", - "ipv6ConnectedPrefix": "2001:db8::/64", - "hybridAksPluginType": "DPDK", - "hybridAksIpamEnabled": "True" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "name": "l3NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l3Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "198.51.100.0/24", - "ipv6ConnectedPrefix": "2001:db8::/64", - "hybridAksPluginType": "DPDK", - "hybridAksIpamEnabled": "True", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L3 network is up" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "name": "l3NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l3Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "198.51.100.0/24", - "ipv6ConnectedPrefix": "2001:db8::/64", - "hybridAksPluginType": "DPDK", - "hybridAksIpamEnabled": "True", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L3 network is up" - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Delete.json deleted file mode 100644 index 57736a0f2d78..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "l3NetworkName": "l3NetworkName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Get.json deleted file mode 100644 index 3ded32168c59..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Get.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "l3NetworkName": "l3NetworkName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "name": "l3NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l3Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "198.51.100.0/24", - "ipv6ConnectedPrefix": "2001:db8::/64", - "hybridAksPluginType": "DPDK", - "hybridAksIpamEnabled": "True", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L3 network is up" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_ListByResourceGroup.json deleted file mode 100644 index 09d7ba659e38..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_ListByResourceGroup.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "name": "l3NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l3Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "198.51.100.0/24", - "ipv6ConnectedPrefix": "2001:db8::/64", - "hybridAksPluginType": "DPDK", - "hybridAksIpamEnabled": "True", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L3 network is up" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_ListBySubscription.json deleted file mode 100644 index 9932e7a76825..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_ListBySubscription.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "name": "l3NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l3Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "198.51.100.0/24", - "ipv6ConnectedPrefix": "2001:db8::/64", - "hybridAksPluginType": "DPDK", - "hybridAksIpamEnabled": "True", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L3 network is up" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Patch.json deleted file mode 100644 index 7be1bb7599ff..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/L3Networks_Patch.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "l3NetworkName": "l3NetworkName", - "l3NetworkUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "name": "l3NetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/l3Networks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "l3IsolationDomainId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", - "vlan": 12, - "ipAllocationType": "DualStack", - "ipv4ConnectedPrefix": "198.51.100.0/24", - "ipv6ConnectedPrefix": "2001:db8::/64", - "hybridAksPluginType": "DPDK", - "hybridAksIpamEnabled": "True", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "L3 network is up" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Operations_List.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Operations_List.json deleted file mode 100644 index 5b0f1f8db38a..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Operations_List.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview" - }, - "responses": { - "200": { - "body": { - "nextLink": "https://fully.qualified.hyperlink", - "value": [ - { - "actionType": "Internal", - "display": { - "description": "Reads Network Cloud cluster(s)", - "operation": "Get/list Network Cloud cluster resources", - "provider": "Microsoft Network Cloud", - "resource": "Network Cloud cluster" - }, - "isDataAction": true, - "name": "Microsoft.NetworkCloud/clusters/Read", - "origin": "user,system" - }, - { - "actionType": "Internal", - "display": { - "description": "Writes Network Cloud cluster(s)", - "operation": "Create/update Network Cloud cluster resources", - "provider": "Microsoft Network Cloud", - "resource": "Network Cloud cluster" - }, - "isDataAction": true, - "name": "Microsoft.NetworkCloud/clusters/Write", - "origin": "user,system" - } - ] - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Create.json deleted file mode 100644 index ceb79a0b70fb..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Create.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "rackName": "rackName", - "rackParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackSkuId": "RACK-TYPE-1", - "rackSerialNumber": "RACK_SERIAL_NUMBER", - "availabilityZone": "1", - "rackLocation": "Rack 28" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "name": "rackName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/racks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackSkuId": "RACK-TYPE-1", - "rackSerialNumber": "RACK_SERIAL_NUMBER", - "availabilityZone": "1", - "rackLocation": "Rack 28", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "detailedStatus": "Available", - "detailedStatusMessage": "Rack is operational" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "name": "rackName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/racks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackSkuId": "RACK-TYPE-1", - "rackSerialNumber": "RACK_SERIAL_NUMBER", - "availabilityZone": "1", - "rackLocation": "Rack 28", - "provisioningState": "Accepted", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "detailedStatus": "Available", - "detailedStatusMessage": "Rack is operational" - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Delete.json deleted file mode 100644 index fc004c7f17a2..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "rackName": "rackName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Get.json deleted file mode 100644 index afc149c430ce..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Get.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "rackName": "rackName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "name": "rackName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/racks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackSkuId": "RACK-TYPE-1", - "rackSerialNumber": "RACK_SERIAL_NUMBER", - "availabilityZone": "1", - "rackLocation": "Rack 28", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "detailedStatus": "Available", - "detailedStatusMessage": "Rack is operational" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_ListByResourceGroup.json deleted file mode 100644 index d2fef4295e0e..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_ListByResourceGroup.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "name": "rackName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/racks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackSkuId": "RACK-TYPE-1", - "rackSerialNumber": "RACK_SERIAL_NUMBER", - "availabilityZone": "1", - "rackLocation": "Rack 28", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "detailedStatus": "Available", - "detailedStatusMessage": "Rack is operational" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_ListBySubscription.json deleted file mode 100644 index e325a07bdbef..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_ListBySubscription.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "name": "rackName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/racks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackSkuId": "RACK-TYPE-1", - "rackSerialNumber": "RACK_SERIAL_NUMBER", - "availabilityZone": "1", - "rackLocation": "Rack 28", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "detailedStatus": "Available", - "detailedStatusMessage": "Rack is operational" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Patch.json deleted file mode 100644 index 2a165181417a..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Racks_Patch.json +++ /dev/null @@ -1,91 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "rackName": "rackName", - "rackUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "rackSerialNumber": "RACK_SERIAL_NUMBER", - "rackLocation": "Rack 2B" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "name": "rackName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/racks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackSkuId": "RACK-TYPE-1", - "rackSerialNumber": "RACK_SERIAL_NUMBER", - "availabilityZone": "1", - "rackLocation": "Rack 28", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "detailedStatus": "Available", - "detailedStatusMessage": "Rack is operational" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "name": "rackName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/racks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackSkuId": "RACK-TYPE-1", - "rackSerialNumber": "RACK_SERIAL_NUMBER", - "availabilityZone": "1", - "rackLocation": "Rack 28", - "provisioningState": "Accepted", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "detailedStatus": "Available", - "detailedStatusMessage": "Rack is operational" - } - }, - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Create.json deleted file mode 100644 index 162883a24340..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Create.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "storageApplianceName": "storageApplianceName", - "storageApplianceParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "storageApplianceSkuId": "684E-3B16-399E", - "rackSlot": 1, - "serialNumber": "BM1219XXX", - "administratorCredentials": { - "username": "adminUser", - "password": "{password}" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", - "name": "storageApplianceName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/storageAppliances", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "storageApplianceSkuId": "684E-3B16-399E", - "rackSlot": 1, - "serialNumber": "BM1219XXX", - "administratorCredentials": { - "username": "adminUser" - }, - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "capacity": 893, - "capacityUsed": 500, - "remoteVendorManagementStatus": "Enabled", - "remoteVendorManagementFeature": "Supported", - "detailedStatus": "Available", - "detailedStatusMessage": "Storage appliance is up and running", - "managementIpv4Address": "192.0.2.2" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", - "name": "storageApplianceName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/storageAppliances", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "storageApplianceSkuId": "684E-3B16-399E", - "rackSlot": 1, - "serialNumber": "BM1219XXX", - "administratorCredentials": { - "username": "adminUser" - }, - "provisioningState": "Accepted", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "capacity": 893, - "capacityUsed": 500, - "remoteVendorManagementStatus": "Enabled", - "remoteVendorManagementFeature": "Supported", - "detailedStatus": "Available", - "detailedStatusMessage": "Storage appliance is up and running", - "managementIpv4Address": "192.0.2.2" - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Delete.json deleted file mode 100644 index 3c3d7fe59ad7..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "storageApplianceName": "storageApplianceName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_DisableRemoteVendorManagement.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_DisableRemoteVendorManagement.json deleted file mode 100644 index a6b01cc9fa51..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_DisableRemoteVendorManagement.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "storageApplianceName": "storageApplianceName" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_EnableRemoteVendorManagement.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_EnableRemoteVendorManagement.json deleted file mode 100644 index 81eca1d0cc98..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_EnableRemoteVendorManagement.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "storageApplianceName": "storageApplianceName", - "storageApplianceEnableRemoteVendorManagementParameters": { - "supportEndpoints": [ - "10.0.0.0/24" - ] - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Get.json deleted file mode 100644 index bc47a1862080..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Get.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "storageApplianceName": "storageApplianceName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", - "name": "storageApplianceName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/storageAppliances", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "storageApplianceSkuId": "684E-3B16-399E", - "rackSlot": 1, - "serialNumber": "BM1219XXX", - "administratorCredentials": { - "username": "adminUser" - }, - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "capacity": 893, - "capacityUsed": 500, - "remoteVendorManagementStatus": "Enabled", - "remoteVendorManagementFeature": "Supported", - "detailedStatus": "Available", - "detailedStatusMessage": "Storage appliance is up and running", - "managementIpv4Address": "192.0.2.2" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_ListByResourceGroup.json deleted file mode 100644 index b78e9164d399..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_ListByResourceGroup.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", - "name": "storageApplianceName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/storageAppliances", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "storageApplianceSkuId": "684E-3B16-399E", - "rackSlot": 1, - "serialNumber": "BM1219XXX", - "administratorCredentials": { - "username": "adminUser" - }, - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "capacity": 893, - "capacityUsed": 500, - "remoteVendorManagementStatus": "Enabled", - "remoteVendorManagementFeature": "Supported", - "detailedStatus": "Available", - "detailedStatusMessage": "Storage appliance is up and running", - "managementIpv4Address": "192.0.2.2" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_ListBySubscription.json deleted file mode 100644 index 6af4364d886e..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_ListBySubscription.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", - "name": "storageApplianceName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/storageAppliances", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "storageApplianceSkuId": "684E-3B16-399E", - "rackSlot": 1, - "serialNumber": "BM1219XXX", - "administratorCredentials": { - "username": "adminUser" - }, - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "capacity": 893, - "capacityUsed": 500, - "remoteVendorManagementStatus": "Enabled", - "remoteVendorManagementFeature": "Supported", - "detailedStatus": "Available", - "detailedStatusMessage": "Storage appliance is up and running", - "managementIpv4Address": "192.0.2.2" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Patch.json deleted file mode 100644 index 2f555ab57358..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_Patch.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "storageApplianceName": "storageApplianceName", - "storageApplianceUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "serialNumber": "BM1219XXX" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", - "name": "storageApplianceName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/storageAppliances", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "storageApplianceSkuId": "684E-3B16-399E", - "rackSlot": 1, - "serialNumber": "BM1219XXX", - "administratorCredentials": { - "username": "adminUser" - }, - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "capacity": 893, - "capacityUsed": 500, - "remoteVendorManagementStatus": "Enabled", - "remoteVendorManagementFeature": "Supported", - "detailedStatus": "Available", - "detailedStatusMessage": "Storage appliance is up and running", - "managementIpv4Address": "192.0.2.2" - } - } - }, - "202": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", - "name": "storageApplianceName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/storageAppliances", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "storageApplianceSkuId": "684E-3B16-399E", - "rackSlot": 1, - "serialNumber": "BM1219XXX", - "administratorCredentials": { - "username": "adminUser" - }, - "provisioningState": "Accepted", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "capacity": 893, - "capacityUsed": 500, - "remoteVendorManagementStatus": "Enabled", - "remoteVendorManagementFeature": "Supported", - "detailedStatus": "Available", - "detailedStatusMessage": "Storage appliance is up and running", - "managementIpv4Address": "192.0.2.2" - } - }, - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_RunReadCommands.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_RunReadCommands.json deleted file mode 100644 index 8db119891c47..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_RunReadCommands.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "storageApplianceName": "storageApplianceName", - "storageApplianceRunReadCommandsParameters": { - "commands": [ - { - "command": "AlertList" - } - ], - "limitTimeSeconds": 60 - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_ValidateHardware.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_ValidateHardware.json deleted file mode 100644 index dbf2f478539e..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/StorageAppliances_ValidateHardware.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "storageApplianceName": "storageApplianceName", - "storageApplianceValidateHardwareParameters": { - "validationCategory": "BasicValidation" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Create.json deleted file mode 100644 index 28bb47205e89..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Create.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "trunkedNetworkName": "trunkedNetworkName", - "trunkedNetworkParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "isolationDomainIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" - ], - "vlans": [ - 12, - 14 - ], - "hybridAksPluginType": "DPDK" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", - "name": "trunkedNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/trunkedNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "isolationDomainIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" - ], - "vlans": [ - 12, - 14 - ], - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Trunked network is up" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", - "name": "trunkedNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/trunkedNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "isolationDomainIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" - ], - "vlans": [ - 12, - 14 - ], - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Trunked network is up" - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Delete.json deleted file mode 100644 index cf945467342a..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "trunkedNetworkName": "trunkedNetworkName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Get.json deleted file mode 100644 index a55ad892d413..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Get.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "trunkedNetworkName": "trunkedNetworkName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", - "name": "trunkedNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/trunkedNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "isolationDomainIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" - ], - "vlans": [ - 12, - 14 - ], - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Trunked network is up" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_ListByResourceGroup.json deleted file mode 100644 index e09cf84e4ff5..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_ListByResourceGroup.json +++ /dev/null @@ -1,60 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", - "name": "trunkedNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/trunkedNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "isolationDomainIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" - ], - "vlans": [ - 12, - 14 - ], - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Trunked network is up" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_ListBySubscription.json deleted file mode 100644 index 78859372e39b..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_ListBySubscription.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", - "name": "trunkedNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/trunkedNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "isolationDomainIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" - ], - "vlans": [ - 12, - 14 - ], - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Trunked network is up" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Patch.json deleted file mode 100644 index b32b37265859..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/TrunkedNetworks_Patch.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "trunkedNetworkName": "trunkedNetworkName", - "trunkedNetworkUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", - "name": "trunkedNetworkName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/trunkedNetworks", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "interfaceName": "eth0", - "isolationDomainIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" - ], - "vlans": [ - 12, - 14 - ], - "hybridAksPluginType": "DPDK", - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "hybridAksClustersAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/hybridAksClusters/hybridAksClusterName" - ], - "virtualMachinesAssociatedIds": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Available", - "detailedStatusMessage": "Trunked network is up" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_AttachVolume.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_AttachVolume.json deleted file mode 100644 index 03cd7289370a..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_AttachVolume.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName", - "virtualMachineAttachVolumeParameters": { - "volumeId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Create.json deleted file mode 100644 index f72fff6acf31..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Create.json +++ /dev/null @@ -1,246 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName", - "virtualMachineParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "vmImage": "myacr.azurecr.io/foobar:latest", - "vmImageRepositoryCredentials": { - "username": "myuser", - "password": "{password}", - "registryUrl": "myacr.azurecr.io" - }, - "vmDeviceModel": "T2", - "cpuCores": 2, - "memorySizeGB": 8, - "storageProfile": { - "osDisk": { - "createOption": "Ephemeral", - "deleteOption": "Delete", - "diskSizeGB": 120 - }, - "volumeAttachments": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - }, - "cloudServicesNetworkAttachment": { - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "ipAllocationMethod": "Dynamic" - }, - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", - "defaultGateway": "True" - } - ], - "placementHints": [ - { - "hintType": "Affinity", - "schedulingExecution": "Hard", - "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "scope": "" - } - ], - "userData": "dXNlckRhdGVTYW1wbGU=", - "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", - "bootMethod": "UEFI", - "adminUsername": "username", - "sshPublicKeys": [ - { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", - "name": "virtualMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "vmImage": "myacr.azurecr.io/foobar:latest", - "vmImageRepositoryCredentials": { - "username": "myuser", - "registryUrl": "myacr.azurecr.io" - }, - "vmDeviceModel": "T2", - "cpuCores": 2, - "memorySizeGB": 8, - "storageProfile": { - "osDisk": { - "createOption": "Ephemeral", - "deleteOption": "Delete", - "diskSizeGB": 120 - }, - "volumeAttachments": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - }, - "cloudServicesNetworkAttachment": { - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "ipAllocationMethod": "Dynamic" - }, - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ], - "placementHints": [ - { - "hintType": "Affinity", - "schedulingExecution": "Hard", - "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "scope": "" - } - ], - "userData": "dXNlckRhdGVTYW1wbGU=", - "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", - "bootMethod": "UEFI", - "adminUsername": "username", - "sshPublicKeys": [ - { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - } - ], - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "detailedStatus": "Available", - "detailedStatusMessage": "VM is up and healthy", - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", - "name": "virtualMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "vmImage": "myacr.azurecr.io/foobar:latest", - "vmImageRepositoryCredentials": { - "username": "myuser", - "registryUrl": "myacr.azurecr.io" - }, - "vmDeviceModel": "T2", - "cpuCores": 2, - "memorySizeGB": 8, - "storageProfile": { - "osDisk": { - "createOption": "Ephemeral", - "deleteOption": "Delete", - "diskSizeGB": 120 - }, - "volumeAttachments": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - }, - "cloudServicesNetworkAttachment": { - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "ipAllocationMethod": "Dynamic" - }, - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ], - "placementHints": [ - { - "hintType": "Affinity", - "schedulingExecution": "Hard", - "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "scope": "" - } - ], - "userData": "dXNlckRhdGVTYW1wbGU=", - "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", - "bootMethod": "UEFI", - "adminUsername": "username", - "sshPublicKeys": [ - { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - } - ], - "provisioningState": "Accepted", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "detailedStatus": "Available", - "detailedStatusMessage": "VM is up and healthy", - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Delete.json deleted file mode 100644 index aaef60c9b139..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_DetachVolume.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_DetachVolume.json deleted file mode 100644 index b8b1981a42d7..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_DetachVolume.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName", - "virtualMachineDetachVolumeParameters": { - "volumeId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Get.json deleted file mode 100644 index fe3185d229e3..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Get.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", - "name": "virtualMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "vmImage": "myacr.azurecr.io/foobar:latest", - "vmImageRepositoryCredentials": { - "username": "myuser", - "registryUrl": "myacr.azurecr.io" - }, - "vmDeviceModel": "T2", - "cpuCores": 2, - "memorySizeGB": 8, - "storageProfile": { - "osDisk": { - "createOption": "Ephemeral", - "deleteOption": "Delete", - "diskSizeGB": 120 - }, - "volumeAttachments": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - }, - "cloudServicesNetworkAttachment": { - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "ipAllocationMethod": "Dynamic" - }, - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ], - "placementHints": [ - { - "hintType": "Affinity", - "schedulingExecution": "Hard", - "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "scope": "" - } - ], - "userData": "dXNlckRhdGVTYW1wbGU=", - "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", - "bootMethod": "UEFI", - "adminUsername": "username", - "sshPublicKeys": [ - { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - } - ], - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "detailedStatus": "Available", - "detailedStatusMessage": "VM is up and healthy", - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_ListByResourceGroup.json deleted file mode 100644 index 0dfc305352bc..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_ListByResourceGroup.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", - "name": "virtualMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "vmImage": "myacr.azurecr.io/foobar:latest", - "vmImageRepositoryCredentials": { - "username": "myuser", - "registryUrl": "myacr.azurecr.io" - }, - "vmDeviceModel": "T2", - "cpuCores": 2, - "memorySizeGB": 8, - "storageProfile": { - "osDisk": { - "createOption": "Ephemeral", - "deleteOption": "Delete", - "diskSizeGB": 120 - }, - "volumeAttachments": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - }, - "cloudServicesNetworkAttachment": { - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "ipAllocationMethod": "Dynamic" - }, - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ], - "placementHints": [ - { - "hintType": "Affinity", - "schedulingExecution": "Hard", - "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "scope": "" - } - ], - "userData": "dXNlckRhdGVTYW1wbGU=", - "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", - "bootMethod": "UEFI", - "adminUsername": "username", - "sshPublicKeys": [ - { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - } - ], - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "detailedStatus": "Available", - "detailedStatusMessage": "VM is up and healthy", - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_ListBySubscription.json deleted file mode 100644 index 03c7356e45c4..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_ListBySubscription.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", - "name": "virtualMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "vmImage": "myacr.azurecr.io/foobar:latest", - "vmImageRepositoryCredentials": { - "username": "myuser", - "registryUrl": "myacr.azurecr.io" - }, - "vmDeviceModel": "T2", - "cpuCores": 2, - "memorySizeGB": 8, - "storageProfile": { - "osDisk": { - "createOption": "Ephemeral", - "deleteOption": "Delete", - "diskSizeGB": 120 - }, - "volumeAttachments": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - }, - "cloudServicesNetworkAttachment": { - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "ipAllocationMethod": "Dynamic" - }, - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ], - "placementHints": [ - { - "hintType": "Affinity", - "schedulingExecution": "Hard", - "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "scope": "" - } - ], - "userData": "dXNlckRhdGVTYW1wbGU=", - "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", - "bootMethod": "UEFI", - "adminUsername": "username", - "sshPublicKeys": [ - { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - } - ], - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "detailedStatus": "Available", - "detailedStatusMessage": "VM is up and healthy", - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Patch.json deleted file mode 100644 index 199265669c11..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Patch.json +++ /dev/null @@ -1,196 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName", - "virtualMachineUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "properties": { - "vmImageRepositoryCredentials": { - "username": "myuser", - "password": "{password}", - "registryUrl": "myacr.azurecr.io" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", - "name": "virtualMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "vmImage": "myacr.azurecr.io/foobar:latest", - "vmImageRepositoryCredentials": { - "username": "myuser", - "registryUrl": "myacr.azurecr.io" - }, - "vmDeviceModel": "T2", - "cpuCores": 2, - "memorySizeGB": 8, - "storageProfile": { - "osDisk": { - "createOption": "Ephemeral", - "deleteOption": "Delete", - "diskSizeGB": 120 - }, - "volumeAttachments": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - }, - "cloudServicesNetworkAttachment": { - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "ipAllocationMethod": "Dynamic" - }, - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ], - "placementHints": [ - { - "hintType": "Affinity", - "schedulingExecution": "Hard", - "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "scope": "" - } - ], - "userData": "dXNlckRhdGVTYW1wbGU=", - "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", - "bootMethod": "UEFI", - "adminUsername": "username", - "sshPublicKeys": [ - { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - } - ], - "provisioningState": "Succeeded", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "detailedStatus": "Available", - "detailedStatusMessage": "VM is up and healthy", - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - } - } - }, - "202": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", - "name": "virtualMachineName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/virtualMachines", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "vmImage": "myacr.azurecr.io/foobar:latest", - "vmImageRepositoryCredentials": { - "username": "myuser", - "registryUrl": "myacr.azurecr.io" - }, - "vmDeviceModel": "T2", - "cpuCores": 2, - "memorySizeGB": 8, - "storageProfile": { - "osDisk": { - "createOption": "Ephemeral", - "deleteOption": "Delete", - "diskSizeGB": 120 - }, - "volumeAttachments": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - }, - "cloudServicesNetworkAttachment": { - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", - "ipAllocationMethod": "Dynamic" - }, - "networkAttachments": [ - { - "networkAttachmentName": "netAttachName01", - "attachedNetworkId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", - "ipAllocationMethod": "Dynamic", - "ipv4Address": "198.51.100.1", - "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", - "macAddress": "bf:1c:29:31:31:1f", - "defaultGateway": "True" - } - ], - "placementHints": [ - { - "hintType": "Affinity", - "schedulingExecution": "Hard", - "resourceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", - "scope": "" - } - ], - "userData": "dXNlckRhdGVTYW1wbGU=", - "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", - "bootMethod": "UEFI", - "adminUsername": "username", - "sshPublicKeys": [ - { - "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" - } - ], - "provisioningState": "Accepted", - "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", - "powerState": "On", - "bareMetalMachineId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", - "detailedStatus": "Available", - "detailedStatusMessage": "VM is up and healthy", - "volumes": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" - ] - } - }, - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_PowerOff.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_PowerOff.json deleted file mode 100644 index c5da89098e09..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_PowerOff.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName", - "virtualMachinePowerOffParameters": { - "skipShutdown": "True" - } - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Reimage.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Reimage.json deleted file mode 100644 index e578ae979813..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Reimage.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Restart.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Restart.json deleted file mode 100644 index e578ae979813..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Restart.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Start.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Start.json deleted file mode 100644 index e578ae979813..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/VirtualMachines_Start.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "virtualMachineName": "virtualMachineName" - }, - "responses": { - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Create.json deleted file mode 100644 index dd5b7c42725c..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Create.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "volumeName": "volumeName", - "volumeParameters": { - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "sizeMiB": 10000 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", - "name": "volumeName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/volumes", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "sizeMiB": 10000, - "provisioningState": "Succeeded", - "serialNumber": "XXXX-XXXX-XXXX-XXXX", - "attachedTo": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Active", - "detailedStatusMessage": "Volume is available" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", - "name": "volumeName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/volumes", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "sizeMiB": 10000, - "provisioningState": "Succeeded", - "serialNumber": "XXXX-XXXX-XXXX-XXXX", - "attachedTo": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Active", - "detailedStatusMessage": "Volume is available" - } - }, - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Delete.json deleted file mode 100644 index aca2a6d0f550..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Delete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "volumeName": "volumeName" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" - } - }, - "204": {} - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Get.json deleted file mode 100644 index 54ba3527c1a2..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Get.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "volumeName": "volumeName" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", - "name": "volumeName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/volumes", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "sizeMiB": 10000, - "provisioningState": "Succeeded", - "serialNumber": "XXXX-XXXX-XXXX-XXXX", - "attachedTo": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Active", - "detailedStatusMessage": "Volume is available" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_ListByResourceGroup.json deleted file mode 100644 index 13b6509faf29..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_ListByResourceGroup.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", - "name": "volumeName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/volumes", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "sizeMiB": 10000, - "provisioningState": "Succeeded", - "serialNumber": "XXXX-XXXX-XXXX-XXXX", - "attachedTo": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Active", - "detailedStatusMessage": "Volume is available" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_ListBySubscription.json deleted file mode 100644 index 341e8f78805c..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_ListBySubscription.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", - "name": "volumeName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/volumes", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "sizeMiB": 10000, - "provisioningState": "Succeeded", - "serialNumber": "XXXX-XXXX-XXXX-XXXX", - "attachedTo": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Active", - "detailedStatusMessage": "Volume is available" - } - } - ], - "nextLink": "https://fully.qualified.hyperlink" - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Patch.json deleted file mode 100644 index e3e2c71591f6..000000000000 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/Volumes_Patch.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", - "resourceGroupName": "resourceGroupName", - "volumeName": "volumeName", - "volumeUpdateParameters": { - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", - "name": "volumeName", - "systemData": { - "createdAt": "2021-01-22T13:27:03.008Z", - "createdBy": "identityA", - "createdByType": "Application", - "lastModifiedAt": "2021-01-22T13:29:03.001Z", - "lastModifiedBy": "identityB", - "lastModifiedByType": "User" - }, - "type": "Microsoft.NetworkCloud/volumes", - "location": "location", - "tags": { - "key1": "myvalue1", - "key2": "myvalue2" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" - }, - "properties": { - "sizeMiB": 10000, - "provisioningState": "Succeeded", - "serialNumber": "XXXX-XXXX-XXXX-XXXX", - "attachedTo": [ - "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" - ], - "detailedStatus": "Active", - "detailedStatusMessage": "Volume is available" - } - } - } - } -} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Create.json new file mode 100644 index 000000000000..064fd6527e8b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Create.json @@ -0,0 +1,255 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName", + "agentPoolParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.24.3-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "provisioningState": "Accepted", + "kubernetesVersion": "1.24.3-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Delete.json new file mode 100644 index 000000000000..63f5c8c02675 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Get.json new file mode 100644 index 000000000000..d16f13cb45fd --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Get.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.24.3-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_ListByKubernetesCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_ListByKubernetesCluster.json new file mode 100644 index 000000000000..116a88d94a6a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_ListByKubernetesCluster.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.24.3-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Patch.json new file mode 100644 index 000000000000..19e9e7b5cf86 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/AgentPools_Patch.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "agentPoolName": "agentPoolName", + "agentPoolUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "administratorConfiguration": { + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "count": 3, + "upgradeSettings": { + "maxSurge": "1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "provisioningState": "Succeeded", + "kubernetesVersion": "1.24.3-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "provisioningState": "Accepted", + "kubernetesVersion": "1.24.3-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Agent pool is available" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Create.json similarity index 80% rename from specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Create.json rename to specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Create.json index cbfb52bddda0..1fe5a50aeda4 100644 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Create.json +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Create.json @@ -1,7 +1,7 @@ { "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", "resourceGroupName": "resourceGroupName", "clusterName": "clusterName", "bareMetalMachineKeySetName": "bareMetalMachineKeySetName", @@ -13,7 +13,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Standard", @@ -30,6 +30,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -37,6 +38,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ] @@ -46,7 +48,7 @@ "responses": { "200": { "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", "name": "bareMetalMachineKeySetName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", @@ -64,7 +66,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Standard", @@ -81,6 +83,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -88,6 +91,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ], @@ -112,7 +116,7 @@ }, "201": { "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", "name": "bareMetalMachineKeySetName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", @@ -130,7 +134,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Standard", @@ -147,6 +151,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -154,6 +159,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ], @@ -161,7 +167,7 @@ } }, "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" } } } diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Delete.json new file mode 100644 index 000000000000..af97f56d05a0 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bareMetalMachineKeySetName": "bareMetalMachineKeySetName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Get.json similarity index 82% rename from specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Get.json rename to specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Get.json index 6508059a1f70..49b1b6f1e34d 100644 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Get.json +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Get.json @@ -1,7 +1,7 @@ { "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", "resourceGroupName": "resourceGroupName", "clusterName": "clusterName", "bareMetalMachineKeySetName": "bareMetalMachineKeySetName" @@ -9,7 +9,7 @@ "responses": { "200": { "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", "name": "bareMetalMachineKeySetName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", @@ -27,7 +27,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Standard", @@ -44,6 +44,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -51,6 +52,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ], diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_ListByCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_ListByCluster.json new file mode 100644 index 000000000000..3e1fcb4beada --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_ListByCluster.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "name": "bareMetalMachineKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bareMetalMachineKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Standard", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "osGroupName": "standardAccessGroup", + "jumpHostsAllowed": [ + "192.0.2.1", + "192.0.2.5" + ], + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Inalid Azure user(s) were provided: userXYZ" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Patch.json similarity index 81% rename from specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Patch.json rename to specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Patch.json index 0d40a7ed53bb..e2de55c9ad64 100644 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BareMetalMachineKeySets_Patch.json +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachineKeySets_Patch.json @@ -1,7 +1,7 @@ { "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", "resourceGroupName": "resourceGroupName", "clusterName": "clusterName", "bareMetalMachineKeySetName": "bareMetalMachineKeySetName", @@ -22,6 +22,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -29,6 +30,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ] @@ -38,7 +40,7 @@ "responses": { "200": { "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", "name": "bareMetalMachineKeySetName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", @@ -56,7 +58,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Standard", @@ -73,6 +75,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -80,6 +83,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ], @@ -104,7 +108,7 @@ }, "202": { "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bareMetalMachineKeySets/bareMetalMachineKeySetName", "name": "bareMetalMachineKeySetName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", @@ -122,7 +126,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Standard", @@ -139,6 +143,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -146,6 +151,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ], @@ -156,7 +162,7 @@ } }, "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" } } } diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Cordon.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Cordon.json new file mode 100644 index 000000000000..20a9d92a9144 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Cordon.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineCordonParameters": { + "evacuate": "True" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Create.json new file mode 100644 index 000000000000..e3e9663b68fa --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Create.json @@ -0,0 +1,197 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser", + "password": "{password}" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.21", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.21", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Delete.json new file mode 100644 index 000000000000..a4444d3bf4ab --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Get.json new file mode 100644 index 000000000000..ca8b6441d59e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Get.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.21", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + } + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_ListByResourceGroup.json new file mode 100644 index 000000000000..ab7d93fe8129 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_ListByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.21", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + } + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_ListBySubscription.json new file mode 100644 index 000000000000..1a4ee63b8d31 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_ListBySubscription.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.21", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + } + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Patch.json new file mode 100644 index 000000000000..d450eac75c87 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Patch.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "machineDetails": "machinedetails" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.21", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "name": "bareMetalMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/bareMetalMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "machineSkuId": "684E-3B16-399E", + "rackSlot": 1, + "machineName": "r01c001", + "bootMacAddress": "00:00:4e:00:58:af", + "bmcMacAddress": "00:00:4f:00:57:00", + "bmcCredentials": { + "username": "bmcuser" + }, + "bmcConnectionString": "bmcconnectionstring", + "machineDetails": "User-provided machine details.", + "serialNumber": "BM1219XXX", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "readyState": "True", + "cordonStatus": "Uncordoned", + "powerState": "On", + "hardwareInventory": { + "interfaces": [ + { + "name": "networkInterfaceName", + "macAddress": "2C:54:91:88:C9:E3", + "linkStatus": "Up", + "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName" + } + ], + "additionalHostInformation": "Machine specific information..." + }, + "detailedStatus": "Available", + "detailedStatusMessage": "DetailedStatusMessage", + "serviceTag": "ST1219XXX", + "kubernetesNodeName": "node01", + "kubernetesVersion": "1.21", + "osImage": "v20220805e", + "oamIpv4Address": "192.0.2.1", + "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001", + "hardwareValidationStatus": { + "result": "Pass", + "lastValidationTime": "2022-09-30T13:27:03.008Z" + }, + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "machineRoles": [ + "platform.afo-nc.microsoft.com/management-plane=true" + ], + "runtimeProtectionStatus": { + "scanScheduledTime": "2023-10-01T13:00:00.000Z", + "scanStartedTime": "2023-09-30T13:00:03.008Z", + "scanCompletedTime": "2023-09-30T13:27:23.103Z", + "definitionsLastUpdated": "2023-09-28T13:27:03.008Z", + "definitionsVersion": "1.2.3" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_PowerOff.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_PowerOff.json new file mode 100644 index 000000000000..2aa09377f927 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_PowerOff.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachinePowerOffParameters": { + "skipShutdown": "True" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Reimage.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Reimage.json new file mode 100644 index 000000000000..5f7f9afefdb4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Reimage.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Replace.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Replace.json new file mode 100644 index 000000000000..8f8f4f3de678 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Replace.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineReplaceParameters": { + "bootMacAddress": "00:00:4e:00:58:af", + "bmcCredentials": { + "username": "bmcuser", + "password": "{password}" + }, + "serialNumber": "BM1219XXX", + "bmcMacAddress": "00:00:4f:00:57:ad", + "machineName": "name" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Restart.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Restart.json new file mode 100644 index 000000000000..5f7f9afefdb4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_RunCommand.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_RunCommand.json new file mode 100644 index 000000000000..1ab48d7131a3 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_RunCommand.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineRunCommandParameters": { + "script": "cHdkCg==", + "arguments": [ + "--argument1", + "argument2" + ], + "limitTimeSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_RunDataExtracts.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_RunDataExtracts.json new file mode 100644 index 000000000000..742e93a2da28 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_RunDataExtracts.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineRunDataExtractsParameters": { + "commands": [ + { + "command": "hardware-support-data-collection", + "arguments": [ + "SysInfo", + "TTYLog" + ] + } + ], + "limitTimeSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_RunReadCommands.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_RunReadCommands.json new file mode 100644 index 000000000000..6b6a40ee087b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_RunReadCommands.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName", + "bareMetalMachineRunReadCommandsParameters": { + "commands": [ + { + "command": "kubectl get", + "arguments": [ + "pods", + "-A" + ] + }, + { + "command": "ping", + "arguments": [ + "192.168.0.99", + "-c", + "3" + ] + } + ], + "limitTimeSeconds": 60 + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Start.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Start.json new file mode 100644 index 000000000000..5f7f9afefdb4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Uncordon.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Uncordon.json new file mode 100644 index 000000000000..5f7f9afefdb4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BareMetalMachines_Uncordon.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "bareMetalMachineName": "bareMetalMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Create.json similarity index 80% rename from specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Create.json rename to specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Create.json index 883b06c1a61d..25f22187b6f5 100644 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Create.json +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Create.json @@ -1,7 +1,7 @@ { "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", "resourceGroupName": "resourceGroupName", "clusterName": "clusterName", "bmcKeySetName": "bmcKeySetName", @@ -13,7 +13,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Administrator", @@ -25,6 +25,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -32,6 +33,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ] @@ -41,7 +43,7 @@ "responses": { "200": { "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", "name": "bmcKeySetName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", @@ -59,7 +61,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Administrator", @@ -71,6 +73,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -78,6 +81,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userXYZ@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ], @@ -102,7 +106,7 @@ }, "201": { "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", "name": "bmcKeySetName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", @@ -120,7 +124,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Administrator", @@ -132,6 +136,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -139,6 +144,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userXYZ@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ], @@ -146,7 +152,7 @@ } }, "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" } } } diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Delete.json new file mode 100644 index 000000000000..3de2d573fb0d --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "bmcKeySetName": "bmcKeySetName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Get.json similarity index 82% rename from specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Get.json rename to specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Get.json index 1acb1047d2e2..af532a71197d 100644 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Get.json +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Get.json @@ -1,7 +1,7 @@ { "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", "resourceGroupName": "resourceGroupName", "clusterName": "clusterName", "bmcKeySetName": "bmcKeySetName" @@ -9,7 +9,7 @@ "responses": { "200": { "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", "name": "bmcKeySetName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", @@ -27,7 +27,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Administrator", @@ -39,6 +39,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -46,6 +47,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userXYZ@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ], diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_ListByCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_ListByCluster.json new file mode 100644 index 000000000000..f316b17289ba --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_ListByCluster.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "name": "bmcKeySetName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/bmcKeySets", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "privilegeLevel": "Administrator", + "expiration": "2022-12-31T23:59:59.008Z", + "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e", + "userList": [ + { + "azureUserName": "userABC", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userABC@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + }, + { + "azureUserName": "userXYZ", + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "userPrincipalName": "userXYZ@contoso.com", + "description": "Needs access for troubleshooting as a part of the support team" + } + ], + "provisioningState": "Succeeded", + "userListStatus": [ + { + "azureUserName": "userABC", + "status": "Active", + "statusMessage": "User has been provisioned" + }, + { + "azureUserName": "userXYZ", + "status": "Invalid", + "statusMessage": "User is not a valid Azure user" + } + ], + "lastValidation": "2022-12-12T12:00:00.008Z", + "detailedStatus": "SomeInvalid", + "detailedStatusMessage": "Inalid Azure user(s) were provided: userXYZ" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Patch.json similarity index 81% rename from specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Patch.json rename to specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Patch.json index 80249eb0f38a..8b4a804a27e4 100644 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/BmcKeySets_Patch.json +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/BmcKeySets_Patch.json @@ -1,7 +1,7 @@ { "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", "resourceGroupName": "resourceGroupName", "clusterName": "clusterName", "bmcKeySetName": "bmcKeySetName", @@ -18,6 +18,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -25,6 +26,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ] @@ -34,7 +36,7 @@ "responses": { "200": { "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", "name": "bmcKeySetName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", @@ -52,7 +54,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Administrator", @@ -64,6 +66,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -71,6 +74,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userXYZ@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ], @@ -95,7 +99,7 @@ }, "202": { "body": { - "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName", "name": "bmcKeySetName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", @@ -113,7 +117,7 @@ }, "extendedLocation": { "type": "CustomLocation", - "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "privilegeLevel": "Administrator", @@ -125,6 +129,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userABC@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" }, { @@ -132,6 +137,7 @@ "sshPublicKey": { "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" }, + "userPrincipalName": "userXYZ@contoso.com", "description": "Needs access for troubleshooting as a part of the support team" } ], @@ -142,7 +148,7 @@ } }, "headers": { - "Location": "https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview" + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" } } } diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Create.json new file mode 100644 index 000000000000..a877255b5deb --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Create.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName", + "cloudServicesNetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Delete.json new file mode 100644 index 000000000000..5ceacd4a76de --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Get.json new file mode 100644 index 000000000000..e3e4f2a5886c --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Get.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..fe3de5fa7521 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_ListByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_ListBySubscription.json new file mode 100644 index 000000000000..5fa8e1e636f0 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_ListBySubscription.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Patch.json new file mode 100644 index 000000000000..41bea7ffc84b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/CloudServicesNetworks_Patch.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "cloudServicesNetworkName": "cloudServicesNetworkName", + "cloudServicesNetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Succeeded", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "name": "cloudServicesNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/cloudServicesNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "additionalEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "enableDefaultEgressEndpoints": "False", + "provisioningState": "Accepted", + "interfaceName": "eth0", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "enabledEgressEndpoints": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "https://storageaccountex.blob.core.windows.net", + "port": 443 + } + ] + } + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Cloud services network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Create.json new file mode 100644 index 000000000000..46efe68b6ae3 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Create.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName", + "clusterManagerParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Accepted", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Delete.json new file mode 100644 index 000000000000..6bda262db182 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Get.json new file mode 100644 index 000000000000..b3f8ab2e1387 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_ListByResourceGroup.json new file mode 100644 index 000000000000..20f3aa739ba5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_ListBySubscription.json new file mode 100644 index 000000000000..d61682dde457 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Patch.json new file mode 100644 index 000000000000..61846b1487fc --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterManagers_Patch.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterManagerName": "clusterManagerName", + "clusterManagerUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "name": "clusterManagerName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusterManagers", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "managerExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "fabricControllerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/fabricControllerName", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterVersions": [ + { + "targetClusterVersion": "1.0.0", + "supportExpiryDate": "2023-04-29" + }, + { + "targetClusterVersion": "1.0.2", + "supportExpiryDate": "2025-01-01" + } + ], + "provisioningState": "Succeeded", + "detailedStatus": "Available", + "detailedStatusMessage": "cluster manager is up and running", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + } + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Create.json new file mode 100644 index 000000000000..f0152c3b3c20 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Create.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default", + "metricsConfigurationParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Accepted", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Delete.json new file mode 100644 index 000000000000..f0dd7c199f59 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Get.json new file mode 100644 index 000000000000..6a9bc4ee521c --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_ListByCluster.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_ListByCluster.json new file mode 100644 index 000000000000..f9aa147fa4f9 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_ListByCluster.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Patch.json new file mode 100644 index 000000000000..7a296c2c1304 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/ClusterMetricsConfigurations_Patch.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "metricsConfigurationName": "default", + "metricsConfigurationUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Succeeded", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/metricsConfigurations/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters/metricsConfigurations", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "enabledMetrics": [ + "metric1", + "metric2" + ], + "collectionInterval": 15, + "provisioningState": "Accepted", + "disabledMetrics": [ + "metric3", + "metric4" + ], + "detailedStatus": "Applied", + "detailedStatusMessage": "Metrics configuration has been successfully applied to all resources." + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Create.json new file mode 100644 index 000000000000..32c798057ecc --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Create.json @@ -0,0 +1,508 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username", + "password": "{password}" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username", + "password": "{password}" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012", + "password": "{password}" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "PendingDeployment", + "detailedStatusMessage": "Cluster creation is accepted. Deployment is pending.", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Delete.json new file mode 100644 index 000000000000..8a47761ed6e4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Deploy.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Deploy.json new file mode 100644 index 000000000000..30c0153d97ce --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Deploy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterDeployParameters": {} + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Deploy_SkipValidation.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Deploy_SkipValidation.json new file mode 100644 index 000000000000..2b2d0165dba8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Deploy_SkipValidation.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterDeployParameters": { + "skipValidationsForMachines": [ + "bmmName1" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Get.json new file mode 100644 index 000000000000..c9f1f60a46ca --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Get.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_ListByResourceGroup.json new file mode 100644 index 000000000000..c0e5822c34ac --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_ListByResourceGroup.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_ListBySubscription.json new file mode 100644 index 000000000000..5e03ba19865e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_ListBySubscription.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json new file mode 100644 index 000000000000..5f832c21c643 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_AggregatorOrSingleRackDefinition.json @@ -0,0 +1,429 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "newSerialNumber", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username", + "password": "{password}" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username", + "password": "{password}" + }, + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "newSerialNumber", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "newSerialNumber", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_Location.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_Location.json new file mode 100644 index 000000000000..1add7a0b8606 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_Location.json @@ -0,0 +1,382 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "clusterLocation": "Foo Street, 3rd Floor, row 9" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_RuntimeProtectionConfiguration.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_RuntimeProtectionConfiguration.json new file mode 100644 index 000000000000..506e4ef43244 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_RuntimeProtectionConfiguration.json @@ -0,0 +1,384 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_SecretArchive.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_SecretArchive.json new file mode 100644 index 000000000000..dbeec4f4d6bc --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_SecretArchive.json @@ -0,0 +1,385 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_UpdateStrategy.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_UpdateStrategy.json new file mode 100644 index 000000000000..0a66d58827b9 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_Patch_UpdateStrategy.json @@ -0,0 +1,388 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Succeeded", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "name": "clusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/clusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "networkFabricId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkFabrics/fabricName", + "clusterType": "SingleRack", + "analyticsWorkspaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/microsoft.operationalInsights/workspaces/logAnalyticsWorkspaceName", + "clusterLocation": "Foo Street, 3rd Floor, row 9", + "clusterVersion": "1.0.0", + "aggregatorOrSingleRackDefinition": { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + }, + "computeRackDefinitions": [ + { + "networkRackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkRacks/networkRackName", + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "AA1234", + "rackLocation": "Foo Datacenter, Floor 3, Aisle 9, Rack 2", + "storageApplianceConfigurationData": [ + { + "rackSlot": 1, + "adminCredentials": { + "username": "username" + }, + "storageApplianceName": "vmName", + "serialNumber": "BM1219XXX" + } + ], + "bareMetalMachineConfigurationData": [ + { + "rackSlot": 1, + "bootMacAddress": "00:BB:CC:DD:EE:FF", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName1", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:FF", + "serialNumber": "BM1219XXX" + }, + { + "rackSlot": 2, + "bootMacAddress": "00:BB:CC:DD:EE:00", + "bmcCredentials": { + "username": "username" + }, + "bmcConnectionString": "bmcConnectionString", + "machineName": "bmmName2", + "machineDetails": "extraDetails", + "bmcMacAddress": "AA:BB:CC:DD:EE:00", + "serialNumber": "BM1219YYY" + } + ] + } + ], + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "clusterServicePrincipal": { + "tenantId": "80000000-4000-4000-4000-120000000000", + "principalId": "00000008-0004-0004-0004-000000000012", + "applicationId": "12345678-1234-1234-1234-123456789012" + }, + "computeDeploymentThreshold": { + "type": "PercentSuccess", + "grouping": "PerCluster", + "value": 90 + }, + "secretArchive": { + "useKeyVault": "True", + "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName" + }, + "updateStrategy": { + "strategyType": "Rack", + "waitTimeMinutes": 10, + "thresholdType": "CountSuccess", + "thresholdValue": 4, + "maxUnavailable": 4 + }, + "runtimeProtectionConfiguration": { + "enforcementLevel": "OnDemand" + }, + "provisioningState": "Accepted", + "clusterExtendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "clusterManagerId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusterManagers/clusterManagerName", + "availableUpgradeVersions": [ + { + "targetClusterVersion": "1.0.2", + "expectedDuration": "0:0:30", + "controlImpact": "False", + "workloadImpact": "False", + "impactDescription": "can be done in place", + "supportExpiryDate": "2025-01-01" + } + ], + "supportExpiryDate": "2023-04-29", + "detailedStatus": "Running", + "detailedStatusMessage": "Cluster is running and healthy", + "clusterManagerConnectionStatus": "Connected", + "clusterConnectionStatus": "Connected", + "workloadResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName" + ], + "clusterCapacity": { + "totalCoreCount": 10, + "availableCoreCount": 10, + "totalMemoryGB": 10, + "availableMemoryGB": 20, + "totalHostStorageGB": 10, + "availableHostStorageGB": 20, + "totalApplianceStorageGB": 10, + "availableApplianceStorageGB": 3 + }, + "manualActionCount": 0 + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_ScanRuntime.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_ScanRuntime.json new file mode 100644 index 000000000000..82aa646aaf64 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_ScanRuntime.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterScanRuntimeParameters": { + "scanActivity": "Scan" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_UpdateVersion.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_UpdateVersion.json new file mode 100644 index 000000000000..5eca8e57d2ee --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Clusters_UpdateVersion.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "clusterName": "clusterName", + "clusterUpdateVersionParameters": { + "targetClusterVersion": "2.0" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Create.json new file mode 100644 index 000000000000..e62eb58a5dc3 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default", + "consoleParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Accepted", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Delete.json new file mode 100644 index 000000000000..8136142b0448 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Get.json new file mode 100644 index 000000000000..539c4dccb68f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_ListByVirtualMachine.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_ListByVirtualMachine.json new file mode 100644 index 000000000000..9d1254683640 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_ListByVirtualMachine.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Patch.json new file mode 100644 index 000000000000..50d9e60137d8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Consoles_Patch.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "consoleName": "default", + "consoleUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "expiration": "2022-06-01T01:27:03.008Z", + "enabled": "True" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Succeeded", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default", + "name": "default", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines/consoles", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" + }, + "properties": { + "sshPublicKey": { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + }, + "enabled": "True", + "expiration": "2022-06-01T01:27:03.008Z", + "provisioningState": "Accepted", + "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls", + "virtualMachineAccessId": "VirtualMachineAccessId", + "detailedStatus": "Ready", + "detailedStatusMessage": "Console is ready for use" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Create.json new file mode 100644 index 000000000000..3de379f79ac5 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Create.json @@ -0,0 +1,716 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G4_v1" + }, + "kubernetesVersion": "1.24.12-1", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G4_v1" + }, + "kubernetesVersion": "1.24.12-1", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.24.13-1", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.24.12-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.24.12-1", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_M16_v1" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G4_v1" + }, + "kubernetesVersion": "1.24.12-1", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Accepted", + "availableUpgrades": [ + { + "version": "1.24.13-1", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.24.12-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.24.12-1", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_M16_v1" + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Delete.json new file mode 100644 index 000000000000..637cf9c566dc --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Get.json new file mode 100644 index 000000000000..3ac7fa483d3d --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Get.json @@ -0,0 +1,271 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G4_v1" + }, + "kubernetesVersion": "1.24.12-1", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.24.13-1", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.24.12-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.24.12-1", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_M16_v1" + } + ] + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..e76f1b8f46b7 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_ListByResourceGroup.json @@ -0,0 +1,274 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G4_v1" + }, + "kubernetesVersion": "1.24.12-1", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.24.13-1", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.24.12-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.24.12-1", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_M16_v1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_ListBySubscription.json new file mode 100644 index 000000000000..b323b082b1d9 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_ListBySubscription.json @@ -0,0 +1,273 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G4_v1" + }, + "kubernetesVersion": "1.24.12-1", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.24.13-1", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.24.12-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.24.12-1", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_M16_v1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Patch.json new file mode 100644 index 000000000000..8a88b02de05f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_Patch.json @@ -0,0 +1,561 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "administratorConfiguration": { + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "count": 3 + }, + "kubernetesVersion": "1.24.12" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G4_v1" + }, + "kubernetesVersion": "1.24.12-1", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Succeeded", + "availableUpgrades": [ + { + "version": "1.24.13-1", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.24.12-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.24.12-1", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_M16_v1" + } + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName", + "name": "KubernetesClusterName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/kubernetesClusters", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "aadConfiguration": { + "adminGroupObjectIds": [ + "ffffffff-ffff-ffff-ffff-ffffffffffff" + ] + }, + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "initialAgentPoolConfigurations": [ + { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "agentOptions": { + "hugepagesCount": 96, + "hugepagesSize": "1G" + }, + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "mode": "System", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "upgradeSettings": { + "maxSurge": "1" + }, + "vmSkuName": "NC_M16_v1", + "name": "SystemPool-1" + } + ], + "controlPlaneNodeConfiguration": { + "administratorConfiguration": { + "adminUsername": "azure", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + }, + "availabilityZones": [ + "1", + "2", + "3" + ], + "count": 3, + "vmSkuName": "NC_G4_v1" + }, + "kubernetesVersion": "1.24.12-1", + "managedResourceGroupConfiguration": { + "name": "my-managed-rg", + "location": "East US" + }, + "networkConfiguration": { + "attachedNetworkConfiguration": { + "l2Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "pluginType": "DPDK" + } + ], + "l3Networks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "pluginType": "SRIOV", + "ipamEnabled": "False" + } + ], + "trunkedNetworks": [ + { + "networkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "pluginType": "MACVLAN" + } + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "bgpAdvertisements": [ + { + "advertiseToFabric": "True", + "communities": [ + "64512:100" + ], + "ipAddressPools": [ + "pool1" + ], + "peers": [ + "peer1" + ] + } + ], + "fabricPeeringEnabled": "True", + "bgpPeers": [ + { + "bfdEnabled": "False", + "bgpMultiHop": "False", + "holdTime": "P300s", + "keepAliveTime": "P300s", + "myAsn": 64512, + "name": "peer1", + "peerAddress": "203.0.113.254", + "peerAsn": 64497, + "peerPort": 179 + } + ], + "ipAddressPools": [ + { + "addresses": [ + "198.51.102.0/24" + ], + "autoAssign": "True", + "name": "pool1", + "onlyUseHostIps": "True" + } + ] + }, + "cloudServicesNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "cniNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "dnsServiceIp": "198.51.101.2", + "podCidrs": [ + "198.51.100.0/24" + ], + "serviceCidrs": [ + "198.51.101.0/24" + ] + }, + "provisioningState": "Accepted", + "availableUpgrades": [ + { + "version": "1.24.13-1", + "availabilityLifecycle": "GenerallyAvailable" + } + ], + "attachedNetworkIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName" + ], + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "connectedClusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Kubernetes/connectedClusters/connectedClusterName", + "controlPlaneKubernetesVersion": "1.24.12-1", + "detailedStatus": "Available", + "detailedStatusMessage": "Kubernetes cluster is operational", + "featureStatuses": [ + { + "name": "Feature1", + "version": "1", + "detailedStatus": "Running", + "detailedStatusMessage": "No issues detected" + } + ], + "nodes": [ + { + "agentPoolId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/kubernetesClusters/kubernetesClusterName/agentPools/agentPoolName", + "availabilityZone": "1", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "cpuCores": 20, + "detailedStatus": "Available", + "detailedStatusMessage": "No issues detected", + "diskSizeGB": 120, + "image": "myacr.azurecr.io/foobar:latest", + "kubernetesVersion": "1.24.12-1", + "labels": [ + { + "key": "kubernetes.label", + "value": "true" + } + ], + "memorySizeGB": 256, + "mode": "System", + "name": "machine1", + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "powerState": "On", + "role": "ControlPlane", + "taints": [ + { + "key": "kubernetes.taint", + "value": "true" + } + ], + "vmSkuName": "NC_M16_v1" + } + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_RestartNode.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_RestartNode.json new file mode 100644 index 000000000000..6ffa6adef560 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/KubernetesClusters_RestartNode.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "kubernetesClusterName": "kubernetesClusterName", + "kubernetesClusterRestartNodeParameters": { + "nodeName": "nodeName" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Create.json new file mode 100644 index 000000000000..34c594eb9935 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Create.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName", + "l2NetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "hybridAksPluginType": "DPDK" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Delete.json new file mode 100644 index 000000000000..2ee45082e8b2 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Get.json new file mode 100644 index 000000000000..402941225e72 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_ListByResourceGroup.json new file mode 100644 index 000000000000..aae344d5140e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_ListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_ListBySubscription.json new file mode 100644 index 000000000000..b4a8d5b909e7 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Patch.json new file mode 100644 index 000000000000..33972d19e188 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L2Networks_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l2NetworkName": "l2NetworkName", + "l2NetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l2Networks/l2NetworkName", + "name": "l2NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l2Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l2IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L2 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Create.json new file mode 100644 index 000000000000..041bc2924b42 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Create.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName", + "l3NetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Delete.json new file mode 100644 index 000000000000..ed30c0563014 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Get.json new file mode 100644 index 000000000000..0d687a0b3e79 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_ListByResourceGroup.json new file mode 100644 index 000000000000..d5e8bd58edd8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_ListBySubscription.json new file mode 100644 index 000000000000..b18bc7d3926f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Patch.json new file mode 100644 index 000000000000..3b4a626cdf8b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/L3Networks_Patch.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "l3NetworkName": "l3NetworkName", + "l3NetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "name": "l3NetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/l3Networks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "l3IsolationDomainId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName", + "vlan": 12, + "ipAllocationType": "DualStack", + "ipv4ConnectedPrefix": "198.51.100.0/24", + "ipv6ConnectedPrefix": "2001:db8::/64", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "L3 network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Operations_List.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..510a9b5ff89b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Operations_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://fully.qualified.hyperlink", + "value": [ + { + "actionType": "Internal", + "display": { + "description": "Reads Network Cloud cluster(s)", + "operation": "Get/list Network Cloud cluster resources", + "provider": "Microsoft Network Cloud", + "resource": "Network Cloud cluster" + }, + "isDataAction": true, + "name": "Microsoft.NetworkCloud/clusters/Read", + "origin": "user,system" + }, + { + "actionType": "Internal", + "display": { + "description": "Writes Network Cloud cluster(s)", + "operation": "Create/update Network Cloud cluster resources", + "provider": "Microsoft Network Cloud", + "resource": "Network Cloud cluster" + }, + "isDataAction": true, + "name": "Microsoft.NetworkCloud/clusters/Write", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/RackSkus_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/RackSkus_Get.json similarity index 93% rename from specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/RackSkus_Get.json rename to specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/RackSkus_Get.json index 1758e619a1e8..31e22ed8248e 100644 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/RackSkus_Get.json +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/RackSkus_Get.json @@ -1,13 +1,13 @@ { "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId", + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", "rackSkuName": "rackSkuName" }, "responses": { "200": { "body": { - "id": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", "name": "rackSkuName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/RackSkus_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/RackSkus_ListBySubscription.json similarity index 93% rename from specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/RackSkus_ListBySubscription.json rename to specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/RackSkus_ListBySubscription.json index 01bc876ad190..f43aa641d6b0 100644 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/examples/RackSkus_ListBySubscription.json +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/RackSkus_ListBySubscription.json @@ -1,14 +1,14 @@ { "parameters": { - "api-version": "2022-12-12-preview", - "subscriptionId": "subscriptionId" + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" }, "responses": { "200": { "body": { "value": [ { - "id": "/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", "name": "rackSkuName", "systemData": { "createdAt": "2021-01-22T13:27:03.008Z", diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Create.json new file mode 100644 index 000000000000..f84dbbe2674e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Create.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName", + "rackParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Delete.json new file mode 100644 index 000000000000..50809fb1df65 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Get.json new file mode 100644 index 000000000000..c52217ea520a --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_ListByResourceGroup.json new file mode 100644 index 000000000000..9fa4c96c549b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_ListBySubscription.json new file mode 100644 index 000000000000..d0ba0bcf7da8 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Patch.json new file mode 100644 index 000000000000..ebb7545024eb --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Racks_Patch.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "rackName": "rackName", + "rackUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "rackLocation": "Rack 2B" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "name": "rackName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/racks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackSkuId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/rackSkus/rackSkuName", + "rackSerialNumber": "RACK_SERIAL_NUMBER", + "availabilityZone": "1", + "rackLocation": "Rack 28", + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "detailedStatus": "Available", + "detailedStatusMessage": "Rack is operational" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Create.json new file mode 100644 index 000000000000..78536a5105a7 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Create.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName", + "storageApplianceParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser", + "password": "{password}" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Delete.json new file mode 100644 index 000000000000..e071d999b10c --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_DisableRemoteVendorManagement.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_DisableRemoteVendorManagement.json new file mode 100644 index 000000000000..bbe0716353da --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_DisableRemoteVendorManagement.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_EnableRemoteVendorManagement.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_EnableRemoteVendorManagement.json new file mode 100644 index 000000000000..23a8d1531a43 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_EnableRemoteVendorManagement.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName", + "storageApplianceEnableRemoteVendorManagementParameters": { + "supportEndpoints": [ + "10.0.0.0/24" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Get.json new file mode 100644 index 000000000000..fd4e239dde28 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_ListByResourceGroup.json new file mode 100644 index 000000000000..14e1aaebacec --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_ListBySubscription.json new file mode 100644 index 000000000000..ea110025600b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Patch.json new file mode 100644 index 000000000000..cc829693db7c --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/StorageAppliances_Patch.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "storageApplianceName": "storageApplianceName", + "storageApplianceUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "serialNumber": "BM1219XXX" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/storageAppliances/storageApplianceName", + "name": "storageApplianceName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/storageAppliances", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "storageApplianceSkuId": "684E-3B16-399E", + "rackSlot": 1, + "serialNumber": "BM1219XXX", + "administratorCredentials": { + "username": "adminUser" + }, + "provisioningState": "Accepted", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "capacity": 893, + "capacityUsed": 500, + "remoteVendorManagementStatus": "Enabled", + "remoteVendorManagementFeature": "Supported", + "detailedStatus": "Available", + "detailedStatusMessage": "Storage appliance is up and running", + "managementIpv4Address": "192.0.2.2" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Create.json new file mode 100644 index 000000000000..fdc42c0c210f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Create.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName", + "trunkedNetworkParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Delete.json new file mode 100644 index 000000000000..f4501dad128b --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Get.json new file mode 100644 index 000000000000..cc8e6f0730fe --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Get.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..0c2efe79d16e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_ListBySubscription.json new file mode 100644 index 000000000000..d4e932a60f82 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Patch.json new file mode 100644 index 000000000000..abd4a0d07afe --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/TrunkedNetworks_Patch.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "trunkedNetworkName": "trunkedNetworkName", + "trunkedNetworkUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/trunkedNetworks/trunkedNetworkName", + "name": "trunkedNetworkName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/trunkedNetworks", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "interfaceName": "eth0", + "isolationDomainIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/l2IsolationDomainName", + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/l3IsolationDomainName" + ], + "vlans": [ + 12, + 14 + ], + "provisioningState": "Succeeded", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "associatedResourceIds": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Available", + "detailedStatusMessage": "Trunked network is up" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Create.json new file mode 100644 index 000000000000..fa405d621ee4 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Create.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "virtualMachineParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "password": "{password}", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Accepted", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Delete.json new file mode 100644 index 000000000000..2bedc929b2dc --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Get.json new file mode 100644 index 000000000000..907bcea43a39 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Get.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_ListByResourceGroup.json new file mode 100644 index 000000000000..719df91b465f --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_ListByResourceGroup.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_ListBySubscription.json new file mode 100644 index 000000000000..437175067277 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_ListBySubscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Patch.json new file mode 100644 index 000000000000..af8593a078ab --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Patch.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "virtualMachineUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "properties": { + "vmImageRepositoryCredentials": { + "username": "myuser", + "password": "{password}", + "registryUrl": "myacr.azurecr.io" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Succeeded", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName", + "name": "virtualMachineName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/virtualMachines", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "vmImage": "myacr.azurecr.io/foobar:latest", + "vmImageRepositoryCredentials": { + "username": "myuser", + "registryUrl": "myacr.azurecr.io" + }, + "vmDeviceModel": "T2", + "cpuCores": 2, + "memorySizeGB": 8, + "storageProfile": { + "osDisk": { + "createOption": "Ephemeral", + "deleteOption": "Delete", + "diskSizeGB": 120 + }, + "volumeAttachments": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + }, + "cloudServicesNetworkAttachment": { + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/cloudServicesNetworks/cloudServicesNetworkName", + "ipAllocationMethod": "Dynamic" + }, + "networkAttachments": [ + { + "networkAttachmentName": "netAttachName01", + "attachedNetworkId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName", + "ipAllocationMethod": "Dynamic", + "ipv4Address": "198.51.100.1", + "ipv6Address": "2001:0db8:0000:0000:0000:0000:0000:0000", + "macAddress": "bf:1c:29:31:31:1f", + "defaultGateway": "True" + } + ], + "placementHints": [ + { + "hintType": "Affinity", + "schedulingExecution": "Hard", + "resourceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", + "scope": "" + } + ], + "userData": "dXNlckRhdGVTYW1wbGU=", + "networkData": "bmV0d29ya0RhdGVTYW1wbGU=", + "bootMethod": "UEFI", + "adminUsername": "username", + "sshPublicKeys": [ + { + "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" + } + ], + "provisioningState": "Accepted", + "availabilityZone": "1", + "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName", + "powerState": "On", + "bareMetalMachineId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", + "detailedStatus": "Available", + "detailedStatusMessage": "VM is up and healthy", + "volumes": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_PowerOff.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_PowerOff.json new file mode 100644 index 000000000000..315c3d77db11 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_PowerOff.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName", + "virtualMachinePowerOffParameters": { + "skipShutdown": "True" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Reimage.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Reimage.json new file mode 100644 index 000000000000..6c1b441d7d8e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Reimage.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Restart.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Restart.json new file mode 100644 index 000000000000..6c1b441d7d8e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Start.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Start.json new file mode 100644 index 000000000000..6c1b441d7d8e --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/VirtualMachines_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "virtualMachineName": "virtualMachineName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Create.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Create.json new file mode 100644 index 000000000000..b9c06430ee61 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Create.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName", + "volumeParameters": { + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Delete.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Delete.json new file mode 100644 index 000000000000..9f6ba9e8bdc1 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Get.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Get.json new file mode 100644 index 000000000000..d8bf6d3fb4dc --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_ListByResourceGroup.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_ListByResourceGroup.json new file mode 100644 index 000000000000..329fdb40d4dd --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_ListBySubscription.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_ListBySubscription.json new file mode 100644 index 000000000000..0f3417f18e45 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + ], + "nextLink": "https://fully.qualified.hyperlink" + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Patch.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Patch.json new file mode 100644 index 000000000000..e5c278e14055 --- /dev/null +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/examples/Volumes_Patch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "123e4567-e89b-12d3-a456-426655440000", + "resourceGroupName": "resourceGroupName", + "volumeName": "volumeName", + "volumeUpdateParameters": { + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/volumes/volumeName", + "name": "volumeName", + "systemData": { + "createdAt": "2021-01-22T13:27:03.008Z", + "createdBy": "identityA", + "createdByType": "Application", + "lastModifiedAt": "2021-01-22T13:29:03.001Z", + "lastModifiedBy": "identityB", + "lastModifiedByType": "User" + }, + "type": "Microsoft.NetworkCloud/volumes", + "location": "location", + "tags": { + "key1": "myvalue1", + "key2": "myvalue2" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" + }, + "properties": { + "sizeMiB": 10000, + "provisioningState": "Succeeded", + "serialNumber": "XXXX-XXXX-XXXX-XXXX", + "attachedTo": [ + "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" + ], + "detailedStatus": "Active", + "detailedStatusMessage": "Volume is available" + } + } + } + } +} diff --git a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/networkcloud.json similarity index 77% rename from specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json rename to specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/networkcloud.json index 4e2d2af34972..b9e10ca03942 100644 --- a/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json +++ b/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-10-01-preview/networkcloud.json @@ -12,7 +12,7 @@ "info": { "description": "The Network Cloud APIs provide management of the on-premises clusters and their resources, such as, racks, bare metal hosts, virtual machines, workload networks and more.", "title": "NetworkCloud", - "version": "2022-12-12-preview" + "version": "2023-10-01-preview" }, "host": "management.azure.com", "paths": { @@ -23,20 +23,20 @@ "operationId": "Operations_List", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -57,10 +57,10 @@ "operationId": "BareMetalMachines_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -73,7 +73,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -94,10 +94,10 @@ "operationId": "CloudServicesNetworks_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -110,7 +110,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -131,10 +131,10 @@ "operationId": "ClusterManagers_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -147,7 +147,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -168,10 +168,10 @@ "operationId": "Clusters_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -184,7 +184,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -198,73 +198,36 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/defaultCniNetworks": { + "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/kubernetesClusters": { "get": { - "description": "Get a list of default CNI networks in the provided subscription.", - "summary": "List default CNI networks in the subscription.", - "operationId": "DefaultCniNetworks_ListBySubscription", + "description": "Get a list of Kubernetes clusters in the provided subscription.", + "summary": "List Kubernetes clusters in the subscription.", + "operationId": "KubernetesClusters_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DefaultCniNetworkList" + "$ref": "#/definitions/KubernetesClusterList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "List default CNI networks for subscription": { - "$ref": "./examples/DefaultCniNetworks_ListBySubscription.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/hybridAksClusters": { - "get": { - "description": "Get a list of additional details related to Hybrid AKS provisioned clusters in the provided subscription.", - "summary": "List additional details related to Hybrid AKS provisioned clusters in the subscription.", - "operationId": "HybridAksClusters_ListBySubscription", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HybridAksClusterList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "List Hybrid AKS provisioned clusters data for subscription": { - "$ref": "./examples/HybridAksClusters_ListBySubscription.json" + "List Kubernetes clusters for subscription": { + "$ref": "./examples/KubernetesClusters_ListBySubscription.json" } }, "x-ms-pageable": { @@ -279,10 +242,10 @@ "operationId": "L2Networks_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -295,7 +258,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -316,10 +279,10 @@ "operationId": "L3Networks_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -332,7 +295,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -353,10 +316,10 @@ "operationId": "RackSkus_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -369,7 +332,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -390,10 +353,10 @@ "operationId": "RackSkus_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/RackSkuNameParameter" @@ -409,7 +372,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -427,10 +390,10 @@ "operationId": "Racks_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -443,7 +406,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -464,10 +427,10 @@ "operationId": "StorageAppliances_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -480,7 +443,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -501,10 +464,10 @@ "operationId": "TrunkedNetworks_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -517,7 +480,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -538,10 +501,10 @@ "operationId": "VirtualMachines_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -554,7 +517,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -575,10 +538,10 @@ "operationId": "Volumes_ListBySubscription", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -591,7 +554,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -612,13 +575,13 @@ "operationId": "BareMetalMachines_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -631,7 +594,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -652,13 +615,13 @@ "operationId": "BareMetalMachines_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -674,7 +637,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -690,13 +653,13 @@ "operationId": "BareMetalMachines_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -733,7 +696,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -753,22 +716,19 @@ "operationId": "BareMetalMachines_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -784,7 +744,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -795,6 +755,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -804,13 +765,13 @@ "operationId": "BareMetalMachines_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -837,7 +798,7 @@ "$ref": "#/definitions/BareMetalMachine" }, "headers": { - "Location": { + "Azure-AsyncOperation": { "type": "string", "description": "The URL to retrieve the status of the asynchronous operation." } @@ -846,7 +807,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -857,7 +818,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } } }, @@ -868,13 +829,13 @@ "operationId": "BareMetalMachines_Cordon", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -898,13 +859,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -915,6 +873,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -926,13 +885,13 @@ "operationId": "BareMetalMachines_PowerOff", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -956,13 +915,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -973,6 +929,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -984,13 +941,13 @@ "operationId": "BareMetalMachines_Reimage", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -1006,13 +963,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1023,6 +977,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -1034,13 +989,13 @@ "operationId": "BareMetalMachines_Replace", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -1064,13 +1019,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1081,6 +1033,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -1092,13 +1045,13 @@ "operationId": "BareMetalMachines_Restart", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -1114,13 +1067,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1131,6 +1081,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -1142,13 +1093,13 @@ "operationId": "BareMetalMachines_RunCommand", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -1173,13 +1124,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1190,6 +1138,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -1201,13 +1150,13 @@ "operationId": "BareMetalMachines_RunDataExtracts", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -1232,13 +1181,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1249,6 +1195,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -1260,13 +1207,13 @@ "operationId": "BareMetalMachines_RunReadCommands", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -1291,13 +1238,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1308,6 +1252,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -1319,13 +1264,13 @@ "operationId": "BareMetalMachines_Start", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -1341,13 +1286,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1358,6 +1300,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -1369,13 +1312,13 @@ "operationId": "BareMetalMachines_Uncordon", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/BareMetalMachineNameParameter" @@ -1391,13 +1334,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1408,65 +1348,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/validateHardware": { - "post": { - "description": "Validate the hardware of the provided bare metal machine.", - "summary": "Trigger hardware validation of the bare metal machine.", - "operationId": "BareMetalMachines_ValidateHardware", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.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/BareMetalMachineNameParameter" - }, - { - "description": "The request body.", - "name": "bareMetalMachineValidateHardwareParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BareMetalMachineValidateHardwareParameters" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string", - "description": "The URL to retrieve the status of the asynchronous operation." - } - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Validate the bare metal machine hardware": { - "$ref": "./examples/BareMetalMachines_ValidateHardware.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -1478,13 +1360,13 @@ "operationId": "CloudServicesNetworks_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -1497,7 +1379,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1518,13 +1400,13 @@ "operationId": "CloudServicesNetworks_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/CloudServicesNetworkNameParameter" @@ -1540,7 +1422,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1556,13 +1438,13 @@ "operationId": "CloudServicesNetworks_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/CloudServicesNetworkNameParameter" @@ -1599,7 +1481,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1619,22 +1501,19 @@ "operationId": "CloudServicesNetworks_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/CloudServicesNetworkNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -1650,7 +1529,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1661,6 +1540,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -1670,13 +1550,13 @@ "operationId": "CloudServicesNetworks_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/CloudServicesNetworkNameParameter" @@ -1703,7 +1583,7 @@ "$ref": "#/definitions/CloudServicesNetwork" }, "headers": { - "Location": { + "Azure-AsyncOperation": { "type": "string", "description": "The URL to retrieve the status of the asynchronous operation." } @@ -1712,7 +1592,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1723,7 +1603,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } } }, @@ -1734,13 +1614,13 @@ "operationId": "ClusterManagers_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -1753,7 +1633,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1774,13 +1654,13 @@ "operationId": "ClusterManagers_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterManagerNameParameter" @@ -1796,7 +1676,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1812,13 +1692,13 @@ "operationId": "ClusterManagers_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterManagerNameParameter" @@ -1855,7 +1735,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1875,22 +1755,19 @@ "operationId": "ClusterManagers_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterManagerNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -1906,7 +1783,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1917,6 +1794,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -1926,13 +1804,13 @@ "operationId": "ClusterManagers_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterManagerNameParameter" @@ -1956,7 +1834,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -1974,13 +1852,13 @@ "operationId": "Clusters_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -1993,7 +1871,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2014,13 +1892,13 @@ "operationId": "Clusters_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -2036,7 +1914,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2052,13 +1930,13 @@ "operationId": "Clusters_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -2095,7 +1973,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2115,22 +1993,19 @@ "operationId": "Clusters_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -2146,7 +2021,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2157,6 +2032,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -2166,13 +2042,13 @@ "operationId": "Clusters_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -2199,7 +2075,7 @@ "$ref": "#/definitions/Cluster" }, "headers": { - "Location": { + "Azure-AsyncOperation": { "type": "string", "description": "The URL to retrieve the status of the asynchronous operation." } @@ -2208,7 +2084,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2218,28 +2094,37 @@ }, "Patch cluster location": { "$ref": "./examples/Clusters_Patch_Location.json" + }, + "Patch runtime protection configuration": { + "$ref": "./examples/Clusters_Patch_RuntimeProtectionConfiguration.json" + }, + "Patch secret archive": { + "$ref": "./examples/Clusters_Patch_SecretArchive.json" + }, + "Patch update strategy": { + "$ref": "./examples/Clusters_Patch_UpdateStrategy.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bareMetalMachineKeySets": { "get": { - "description": "Get a list of bare metal machine key sets of the cluster in the provided resource group.", - "summary": "List bare metal machine key sets of the cluster in the resource group.", - "operationId": "BareMetalMachineKeySets_ListByResourceGroup", + "description": "Get a list of bare metal machine key sets for the provided cluster.", + "summary": "List bare metal machine key sets of the cluster.", + "operationId": "BareMetalMachineKeySets_ListByCluster", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -2255,13 +2140,13 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "List bare metal machine key set of cluster for resource group": { - "$ref": "./examples/BareMetalMachineKeySets_ListByResourceGroup.json" + "List bare metal machine key sets of the cluster": { + "$ref": "./examples/BareMetalMachineKeySets_ListByCluster.json" } }, "x-ms-pageable": { @@ -2276,19 +2161,19 @@ "operationId": "BareMetalMachineKeySets_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/BareMetalMachineKeySetName" + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" } ], "responses": { @@ -2301,7 +2186,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2317,19 +2202,19 @@ "operationId": "BareMetalMachineKeySets_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/BareMetalMachineKeySetName" + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" }, { "description": "The request body.", @@ -2363,7 +2248,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2383,25 +2268,22 @@ "operationId": "BareMetalMachineKeySets_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/BareMetalMachineKeySetName" + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -2417,7 +2299,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2428,6 +2310,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -2437,19 +2320,19 @@ "operationId": "BareMetalMachineKeySets_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/BareMetalMachineKeySetName" + "$ref": "#/parameters/BareMetalMachineKeySetNameParameter" }, { "description": "The request body.", @@ -2473,7 +2356,7 @@ "$ref": "#/definitions/BareMetalMachineKeySet" }, "headers": { - "Location": { + "Azure-AsyncOperation": { "type": "string", "description": "The URL to retrieve the status of the asynchronous operation." } @@ -2482,7 +2365,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2493,24 +2376,24 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets": { "get": { - "description": "Get a list of baseboard management controller key sets of the cluster in the provided resource group.", - "summary": "List baseboard management controller key sets of the cluster in the resource group.", - "operationId": "BmcKeySets_ListByResourceGroup", + "description": "Get a list of baseboard management controller key sets for the provided cluster.", + "summary": "List baseboard management controller key sets of the cluster.", + "operationId": "BmcKeySets_ListByCluster", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -2526,13 +2409,13 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "List baseboard management controller key set of cluster for resource group": { - "$ref": "./examples/BmcKeySets_ListByResourceGroup.json" + "List baseboard management controller key sets of the cluster": { + "$ref": "./examples/BmcKeySets_ListByCluster.json" } }, "x-ms-pageable": { @@ -2547,19 +2430,19 @@ "operationId": "BmcKeySets_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/BmcKeySetName" + "$ref": "#/parameters/BmcKeySetNameParameter" } ], "responses": { @@ -2572,7 +2455,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2588,19 +2471,19 @@ "operationId": "BmcKeySets_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/BmcKeySetName" + "$ref": "#/parameters/BmcKeySetNameParameter" }, { "description": "The request body.", @@ -2634,7 +2517,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2654,25 +2537,22 @@ "operationId": "BmcKeySets_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/BmcKeySetName" + "$ref": "#/parameters/BmcKeySetNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -2688,7 +2568,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2699,6 +2579,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -2708,19 +2589,19 @@ "operationId": "BmcKeySets_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { - "$ref": "#/parameters/BmcKeySetName" + "$ref": "#/parameters/BmcKeySetNameParameter" }, { "description": "The request body.", @@ -2744,7 +2625,7 @@ "$ref": "#/definitions/BmcKeySet" }, "headers": { - "Location": { + "Azure-AsyncOperation": { "type": "string", "description": "The URL to retrieve the status of the asynchronous operation." } @@ -2753,7 +2634,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2764,24 +2645,24 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/deploy": { "post": { - "description": "Deploy the cluster to the provided rack.", - "summary": "Deploy the cluster to the rack.", + "description": "Deploy the cluster using the rack configuration provided during creation.", + "summary": "Deploy the cluster.", "operationId": "Clusters_Deploy", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -2805,13 +2686,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2825,24 +2703,25 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/metricsConfigurations": { "get": { - "description": "Get a list of metrics configurations of the clusters in the provided resource group.", - "summary": "List metrics configurations of the cluster in the resource group.", - "operationId": "MetricsConfigurations_ListByResourceGroup", + "description": "Get a list of metrics configurations for the provided cluster.", + "summary": "List metrics configurations of the cluster.", + "operationId": "MetricsConfigurations_ListByCluster", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -2858,13 +2737,13 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "List metrics configurations of cluster for resource group": { - "$ref": "./examples/ClusterMetricsConfigurations_ListByResourceGroup.json" + "List metrics configurations of the cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_ListByCluster.json" } }, "x-ms-pageable": { @@ -2879,13 +2758,13 @@ "operationId": "MetricsConfigurations_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -2904,7 +2783,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -2915,18 +2794,18 @@ } }, "put": { - "description": "Update the metrics configuration of the provided cluster.", - "summary": "Update the metrics configuration of the cluster.", + "description": "Create new or update the existing metrics configuration of the provided cluster.", + "summary": "Create or update metrics configuration of the cluster.", "operationId": "MetricsConfigurations_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -2966,13 +2845,13 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Update metrics configuration of cluster": { - "$ref": "./examples/ClusterMetricsConfigurations_Update.json" + "Create or update metrics configuration of cluster": { + "$ref": "./examples/ClusterMetricsConfigurations_Create.json" } }, "x-ms-long-running-operation": true, @@ -2986,13 +2865,13 @@ "operationId": "MetricsConfigurations_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -3002,9 +2881,6 @@ } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -3020,7 +2896,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -3031,6 +2907,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -3040,13 +2917,13 @@ "operationId": "MetricsConfigurations_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -3076,7 +2953,7 @@ "$ref": "#/definitions/ClusterMetricsConfiguration" }, "headers": { - "Location": { + "Azure-AsyncOperation": { "type": "string", "description": "The URL to retrieve the status of the asynchronous operation." } @@ -3085,7 +2962,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -3096,6 +2973,62 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/scanRuntime": { + "post": { + "description": "Triggers the execution of a runtime protection scan to detect and remediate detected issues, in accordance with the cluster configuration.", + "summary": "Execute a runtime protection scan on the cluster.", + "operationId": "Clusters_ScanRuntime", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "description": "The request body.", + "name": "ClusterScanRuntimeParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ClusterScanRuntimeParameters" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Execute a runtime protection scan on the cluster": { + "$ref": "./examples/Clusters_ScanRuntime.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -3107,13 +3040,13 @@ "operationId": "Clusters_UpdateVersion", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" @@ -3138,13 +3071,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -3155,43 +3085,44 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/defaultCniNetworks": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters": { "get": { - "description": "Get a list of default CNI networks in the provided resource group.", - "summary": "List default CNI networks in the resource group.", - "operationId": "DefaultCniNetworks_ListByResourceGroup", + "description": "Get a list of Kubernetes clusters in the provided resource group.", + "summary": "List Kubernetes clusters in the resource group.", + "operationId": "KubernetesClusters_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DefaultCniNetworkList" + "$ref": "#/definitions/KubernetesClusterList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "List default CNI networks for resource group": { - "$ref": "./examples/DefaultCniNetworks_ListByResourceGroup.json" + "List Kubernetes clusters for resource group": { + "$ref": "./examples/KubernetesClusters_ListByResourceGroup.json" } }, "x-ms-pageable": { @@ -3199,69 +3130,69 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/defaultCniNetworks/{defaultCniNetworkName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}": { "get": { - "description": "Get properties of the provided default CNI network.", - "summary": "Retrieve the default CNI network.", - "operationId": "DefaultCniNetworks_Get", + "description": "Get properties of the provided the Kubernetes cluster.", + "summary": "Retrieve the Kubernetes cluster.", + "operationId": "KubernetesClusters_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/DefaultCniNetworkNameParameter" + "$ref": "#/parameters/KubernetesClusterNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DefaultCniNetwork" + "$ref": "#/definitions/KubernetesCluster" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Get default CNI network": { - "$ref": "./examples/DefaultCniNetworks_Get.json" + "Get Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Get.json" } } }, "put": { - "description": "Create a new default CNI network or update the properties of the existing default CNI network.", - "summary": "Create or update the default CNI network.", - "operationId": "DefaultCniNetworks_CreateOrUpdate", + "description": "Create a new Kubernetes cluster or update the properties of the existing one.", + "summary": "Create or update the Kubernetes cluster.", + "operationId": "KubernetesClusters_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/DefaultCniNetworkNameParameter" + "$ref": "#/parameters/KubernetesClusterNameParameter" }, { "description": "The request body.", - "name": "defaultCniNetworkParameters", + "name": "kubernetesClusterParameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/DefaultCniNetwork" + "$ref": "#/definitions/KubernetesCluster" } } ], @@ -3269,13 +3200,13 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DefaultCniNetwork" + "$ref": "#/definitions/KubernetesCluster" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/DefaultCniNetwork" + "$ref": "#/definitions/KubernetesCluster" }, "headers": { "Azure-AsyncOperation": { @@ -3287,13 +3218,13 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Create or update default CNI network": { - "$ref": "./examples/DefaultCniNetworks_Create.json" + "Create or update Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Create.json" } }, "x-ms-long-running-operation": true, @@ -3302,27 +3233,24 @@ } }, "delete": { - "description": "Delete the provided default CNI network.", - "summary": "Delete the default CNI network.", - "operationId": "DefaultCniNetworks_Delete", + "description": "Delete the provided Kubernetes cluster.", + "summary": "Delete the Kubernetes cluster.", + "operationId": "KubernetesClusters_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/DefaultCniNetworkNameParameter" + "$ref": "#/parameters/KubernetesClusterNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -3338,43 +3266,44 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Delete default CNI network": { - "$ref": "./examples/DefaultCniNetworks_Delete.json" + "Delete Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Delete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, "patch": { - "description": "Update tags associated with the provided default CNI network.", - "summary": "Patch the default CNI network.", - "operationId": "DefaultCniNetworks_Update", + "description": "Patch the properties of the provided Kubernetes cluster, or update the tags associated with the Kubernetes cluster. Properties and tag updates can be done independently.", + "summary": "Patch the Kubernetes cluster.", + "operationId": "KubernetesClusters_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/DefaultCniNetworkNameParameter" + "$ref": "#/parameters/KubernetesClusterNameParameter" }, { "description": "The request body.", - "name": "defaultCniNetworkUpdateParameters", + "name": "kubernetesClusterUpdateParameters", "in": "body", "schema": { - "$ref": "#/definitions/DefaultCniNetworkPatchParameters" + "$ref": "#/definitions/KubernetesClusterPatchParameters" } } ], @@ -3382,56 +3311,75 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DefaultCniNetwork" + "$ref": "#/definitions/KubernetesCluster" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/KubernetesCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Patch default CNI network": { - "$ref": "./examples/DefaultCniNetworks_Patch.json" + "Patch Kubernetes cluster": { + "$ref": "./examples/KubernetesClusters_Patch.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/hybridAksClusters": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools": { "get": { - "description": "Get a list of additional details for Hybrid AKS provisioned clusters in the provided resource group.", - "summary": "List additional details related to Hybrid AKS provisioned clusters in the resource group.", - "operationId": "HybridAksClusters_ListByResourceGroup", + "description": "Get a list of agent pools for the provided Kubernetes cluster.", + "summary": "List agent pools of the Kubernetes cluster.", + "operationId": "AgentPools_ListByKubernetesCluster", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/KubernetesClusterNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridAksClusterList" + "$ref": "#/definitions/AgentPoolList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "List Hybrid AKS provisioned clusters data for resource group": { - "$ref": "./examples/HybridAksClusters_ListByResourceGroup.json" + "List agent pools of the Kubernetes cluster": { + "$ref": "./examples/AgentPools_ListByKubernetesCluster.json" } }, "x-ms-pageable": { @@ -3439,69 +3387,75 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/hybridAksClusters/{hybridAksClusterName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/agentPools/{agentPoolName}": { "get": { - "description": "Get the additional details related to the provided Hybrid AKS provisioned cluster.", - "summary": "Retrieve the additional details related to the Hybrid AKS provisioned cluster.", - "operationId": "HybridAksClusters_Get", + "description": "Get properties of the provided Kubernetes cluster agent pool.", + "summary": "Retrieve the Kubernetes cluster agent pool.", + "operationId": "AgentPools_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/KubernetesClusterNameParameter" }, { - "$ref": "#/parameters/HybridAksClusterNameParameter" + "$ref": "#/parameters/AgentPoolNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridAksCluster" + "$ref": "#/definitions/AgentPool" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Get Hybrid AKS provisioned cluster data": { - "$ref": "./examples/HybridAksClusters_Get.json" + "Get Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Get.json" } } }, "put": { - "description": "Create new additional details related to the Hybrid AKS provisioned cluster or update the existing one.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", - "summary": "Create or update the additional details related to the Hybrid AKS provisioned cluster.", - "operationId": "HybridAksClusters_CreateOrUpdate", + "description": "Create a new Kubernetes cluster agent pool or update the properties of the existing one.", + "summary": "Create or update the Kubernetes cluster agent pool.", + "operationId": "AgentPools_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/KubernetesClusterNameParameter" }, { - "$ref": "#/parameters/HybridAksClusterNameParameter" + "$ref": "#/parameters/AgentPoolNameParameter" }, { "description": "The request body.", - "name": "hybridAksClusterParameters", + "name": "agentPoolParameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/HybridAksCluster" + "$ref": "#/definitions/AgentPool" } } ], @@ -3509,13 +3463,13 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridAksCluster" + "$ref": "#/definitions/AgentPool" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/HybridAksCluster" + "$ref": "#/definitions/AgentPool" }, "headers": { "Azure-AsyncOperation": { @@ -3527,13 +3481,13 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Create or update Hybrid AKS provisioned cluster data": { - "$ref": "./examples/HybridAksClusters_Create.json" + "Create or update Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Create.json" } }, "x-ms-long-running-operation": true, @@ -3542,27 +3496,27 @@ } }, "delete": { - "description": "Delete the additional details related to the provided Hybrid AKS provisioned cluster.\nAll customer initiated requests will be rejected as the life cycle of this resource is managed by the system.", - "summary": "Delete the additional details related to the Hybrid AKS provisioned cluster.", - "operationId": "HybridAksClusters_Delete", + "description": "Delete the provided Kubernetes cluster agent pool.", + "summary": "Delete the Kubernetes cluster agent pool.", + "operationId": "AgentPools_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/KubernetesClusterNameParameter" }, { - "$ref": "#/parameters/HybridAksClusterNameParameter" + "$ref": "#/parameters/AgentPoolNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -3578,43 +3532,47 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Delete Hybrid AKS provisioned cluster data": { - "$ref": "./examples/HybridAksClusters_Delete.json" + "Delete Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Delete.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, "patch": { - "description": "Update tags associated with the additional details related to the Hybrid AKS provisioned cluster.", - "summary": "Patch the additional details related to the Hybrid AKS provisioned cluster.", - "operationId": "HybridAksClusters_Update", + "description": "Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently.", + "summary": "Patch the Kubernetes cluster agent pool.", + "operationId": "AgentPools_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/KubernetesClusterNameParameter" }, { - "$ref": "#/parameters/HybridAksClusterNameParameter" + "$ref": "#/parameters/AgentPoolNameParameter" }, { "description": "The request body.", - "name": "hybridAksClusterUpdateParameters", + "name": "agentPoolUpdateParameters", "in": "body", "schema": { - "$ref": "#/definitions/HybridAksClusterPatchParameters" + "$ref": "#/definitions/AgentPoolPatchParameters" } } ], @@ -3622,48 +3580,64 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridAksCluster" + "$ref": "#/definitions/AgentPool" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "The URL to retrieve the status of the asynchronous operation." + } } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Patch Hybrid AKS provisioned cluster data": { - "$ref": "./examples/HybridAksClusters_Patch.json" + "Patch Kubernetes cluster agent pool": { + "$ref": "./examples/AgentPools_Patch.json" } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/hybridAksClusters/{hybridAksClusterName}/restartNode": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/kubernetesClusters/{kubernetesClusterName}/restartNode": { "post": { - "description": "Restart a targeted node of a Hybrid AKS cluster.", + "description": "Restart a targeted node of a Kubernetes cluster.", "summary": "Restart a targeted node.", - "operationId": "HybridAksClusters_RestartNode", + "operationId": "KubernetesClusters_RestartNode", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/HybridAksClusterNameParameter" + "$ref": "#/parameters/KubernetesClusterNameParameter" }, { "description": "The request body.", - "name": "hybridAksClusterRestartNodeParameters", + "name": "kubernetesClusterRestartNodeParameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/HybridAksClusterRestartNodeParameters" + "$ref": "#/definitions/KubernetesClusterRestartNodeParameters" } } ], @@ -3677,23 +3651,21 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Restart a Hybrid AKS cluster node": { - "$ref": "./examples/HybridAksClusters_RestartNode.json" + "Restart a Kubernetes cluster node": { + "$ref": "./examples/KubernetesClusters_RestartNode.json" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -3705,13 +3677,13 @@ "operationId": "L2Networks_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -3724,7 +3696,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -3745,13 +3717,13 @@ "operationId": "L2Networks_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/L2NetworkNameParameter" @@ -3767,7 +3739,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -3783,13 +3755,13 @@ "operationId": "L2Networks_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/L2NetworkNameParameter" @@ -3826,7 +3798,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -3846,22 +3818,19 @@ "operationId": "L2Networks_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/L2NetworkNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -3877,7 +3846,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -3888,6 +3857,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -3897,13 +3867,13 @@ "operationId": "L2Networks_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/L2NetworkNameParameter" @@ -3927,7 +3897,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -3945,13 +3915,13 @@ "operationId": "L3Networks_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -3964,7 +3934,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -3985,13 +3955,13 @@ "operationId": "L3Networks_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/L3NetworkNameParameter" @@ -4007,7 +3977,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4023,13 +3993,13 @@ "operationId": "L3Networks_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/L3NetworkNameParameter" @@ -4066,7 +4036,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4086,22 +4056,19 @@ "operationId": "L3Networks_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/L3NetworkNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -4117,7 +4084,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4128,6 +4095,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -4137,13 +4105,13 @@ "operationId": "L3Networks_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/L3NetworkNameParameter" @@ -4167,7 +4135,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4185,13 +4153,13 @@ "operationId": "Racks_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -4204,7 +4172,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4225,13 +4193,13 @@ "operationId": "Racks_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/RackNameParameter" @@ -4247,7 +4215,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4263,13 +4231,13 @@ "operationId": "Racks_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/RackNameParameter" @@ -4306,7 +4274,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4326,22 +4294,19 @@ "operationId": "Racks_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/RackNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -4357,7 +4322,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4368,6 +4333,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -4377,13 +4343,13 @@ "operationId": "Racks_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/RackNameParameter" @@ -4410,7 +4376,7 @@ "$ref": "#/definitions/Rack" }, "headers": { - "Location": { + "Azure-AsyncOperation": { "type": "string", "description": "The URL to retrieve the status of the asynchronous operation." } @@ -4419,7 +4385,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4430,7 +4396,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } } }, @@ -4441,13 +4407,13 @@ "operationId": "StorageAppliances_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -4460,7 +4426,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4481,13 +4447,13 @@ "operationId": "StorageAppliances_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/StorageApplianceNameParameter" @@ -4503,7 +4469,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4519,13 +4485,13 @@ "operationId": "StorageAppliances_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/StorageApplianceNameParameter" @@ -4562,7 +4528,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4582,22 +4548,19 @@ "operationId": "StorageAppliances_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/StorageApplianceNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -4613,7 +4576,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4624,22 +4587,23 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, "patch": { - "description": "Patch properties of the provided bare metal machine, or update tags associated with the bare metal machine. Properties and tag updates can be done independently.", + "description": "Update properties of the provided storage appliance, or update tags associated with the storage appliance Properties and tag updates can be done independently.", "summary": "Patch the storage appliance.", "operationId": "StorageAppliances_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/StorageApplianceNameParameter" @@ -4666,7 +4630,7 @@ "$ref": "#/definitions/StorageAppliance" }, "headers": { - "Location": { + "Azure-AsyncOperation": { "type": "string", "description": "The URL to retrieve the status of the asynchronous operation." } @@ -4675,7 +4639,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4686,7 +4650,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } } }, @@ -4697,13 +4661,13 @@ "operationId": "StorageAppliances_DisableRemoteVendorManagement", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/StorageApplianceNameParameter" @@ -4719,13 +4683,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4736,6 +4697,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -4747,13 +4709,13 @@ "operationId": "StorageAppliances_EnableRemoteVendorManagement", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/StorageApplianceNameParameter" @@ -4777,13 +4739,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4794,124 +4753,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/runReadCommands": { - "post": { - "description": "Run and retrieve output from read only commands on the provided storage appliance.", - "summary": "Retrieve output from read-only commands exercised against a storage appliance.", - "operationId": "StorageAppliances_RunReadCommands", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.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/StorageApplianceNameParameter" - }, - { - "description": "The request body.", - "name": "storageApplianceRunReadCommandsParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageApplianceRunReadCommandsParameters" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string", - "description": "The URL to retrieve the status of the asynchronous operation." - } - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Run and retrieve output from read only commands on storage appliance.": { - "$ref": "./examples/StorageAppliances_RunReadCommands.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/validateHardware": { - "post": { - "description": "Validate the hardware of the provided storage appliance.", - "summary": "Trigger hardware validation of the storage appliance.", - "operationId": "StorageAppliances_ValidateHardware", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.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/StorageApplianceNameParameter" - }, - { - "description": "The request body.", - "name": "storageApplianceValidateHardwareParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageApplianceValidateHardwareParameters" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string", - "description": "The URL to retrieve the status of the asynchronous operation." - } - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Validate the storage appliance hardware": { - "$ref": "./examples/StorageAppliances_ValidateHardware.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -4923,13 +4765,13 @@ "operationId": "TrunkedNetworks_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -4942,7 +4784,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -4963,13 +4805,13 @@ "operationId": "TrunkedNetworks_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/TrunkedNetworkNameParameter" @@ -4985,7 +4827,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5001,13 +4843,13 @@ "operationId": "TrunkedNetworks_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/TrunkedNetworkNameParameter" @@ -5044,7 +4886,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5064,22 +4906,19 @@ "operationId": "TrunkedNetworks_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/TrunkedNetworkNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -5095,7 +4934,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5106,6 +4945,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -5115,13 +4955,13 @@ "operationId": "TrunkedNetworks_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/TrunkedNetworkNameParameter" @@ -5145,7 +4985,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5163,13 +5003,13 @@ "operationId": "VirtualMachines_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -5182,7 +5022,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5203,13 +5043,13 @@ "operationId": "VirtualMachines_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5225,7 +5065,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5241,13 +5081,13 @@ "operationId": "VirtualMachines_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5284,7 +5124,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5304,22 +5144,19 @@ "operationId": "VirtualMachines_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -5335,7 +5172,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5346,6 +5183,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -5355,13 +5193,13 @@ "operationId": "VirtualMachines_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5388,7 +5226,7 @@ "$ref": "#/definitions/VirtualMachine" }, "headers": { - "Location": { + "Azure-AsyncOperation": { "type": "string", "description": "The URL to retrieve the status of the asynchronous operation." } @@ -5397,7 +5235,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5408,83 +5246,24 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/attachVolume": { - "post": { - "description": "Attach volume to the provided virtual machine.", - "summary": "Attach volume to the virtual machine.", - "operationId": "VirtualMachines_AttachVolume", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.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/VirtualMachineNameParameter" - }, - { - "description": "The request body.", - "name": "virtualMachineAttachVolumeParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineVolumeParameters" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string", - "description": "The URL to retrieve the status of the asynchronous operation." - } - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Attach volume to virtual machine": { - "$ref": "./examples/VirtualMachines_AttachVolume.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles": { "get": { - "description": "Get a list of virtual machine consoles in the provided resource group.", - "summary": "List virtual machine consoles in the resource group.", - "operationId": "Consoles_ListByResourceGroup", + "description": "Get a list of consoles for the provided virtual machine.", + "summary": "List consoles of the virtual machine.", + "operationId": "Consoles_ListByVirtualMachine", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5500,13 +5279,13 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "List virtual machine consoles for resource group": { - "$ref": "./examples/Consoles_ListByResourceGroup.json" + "List consoles of the virtual machine": { + "$ref": "./examples/Consoles_ListByVirtualMachine.json" } }, "x-ms-pageable": { @@ -5521,13 +5300,13 @@ "operationId": "Consoles_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5546,7 +5325,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5562,13 +5341,13 @@ "operationId": "Consoles_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5608,7 +5387,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5628,13 +5407,13 @@ "operationId": "Consoles_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5644,9 +5423,6 @@ } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -5662,7 +5438,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5673,6 +5449,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -5682,13 +5459,13 @@ "operationId": "Consoles_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5718,7 +5495,7 @@ "$ref": "#/definitions/Console" }, "headers": { - "Location": { + "Azure-AsyncOperation": { "type": "string", "description": "The URL to retrieve the status of the asynchronous operation." } @@ -5727,7 +5504,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5738,66 +5515,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/detachVolume": { - "post": { - "description": "Detach volume from the provided virtual machine.", - "summary": "Detach volume from the virtual machine.", - "operationId": "VirtualMachines_DetachVolume", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.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/VirtualMachineNameParameter" - }, - { - "description": "The request body.", - "name": "virtualMachineDetachVolumeParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineVolumeParameters" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "headers": { - "Location": { - "type": "string", - "description": "The URL to retrieve the status of the asynchronous operation." - } - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Detach volume from virtual machine": { - "$ref": "./examples/VirtualMachines_DetachVolume.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "final-state-via": "azure-async-operation" } } }, @@ -5808,13 +5526,13 @@ "operationId": "VirtualMachines_PowerOff", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5838,13 +5556,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5855,6 +5570,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -5866,13 +5582,13 @@ "operationId": "VirtualMachines_Reimage", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5888,13 +5604,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5905,6 +5618,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -5916,13 +5630,13 @@ "operationId": "VirtualMachines_Restart", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5938,13 +5652,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -5955,6 +5666,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -5966,13 +5678,13 @@ "operationId": "VirtualMachines_Start", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VirtualMachineNameParameter" @@ -5988,13 +5700,10 @@ } } }, - "204": { - "description": "No Content" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6005,6 +5714,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } } @@ -6016,13 +5726,13 @@ "operationId": "Volumes_ListByResourceGroup", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { @@ -6035,7 +5745,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6056,13 +5766,13 @@ "operationId": "Volumes_Get", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VolumeNameParameter" @@ -6078,7 +5788,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6094,13 +5804,13 @@ "operationId": "Volumes_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VolumeNameParameter" @@ -6137,7 +5847,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6157,22 +5867,19 @@ "operationId": "Volumes_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VolumeNameParameter" } ], "responses": { - "200": { - "description": "OK" - }, "202": { "description": "Accepted", "headers": { @@ -6188,7 +5895,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6199,6 +5906,7 @@ }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { + "final-state-schema": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult", "final-state-via": "location" } }, @@ -6208,13 +5916,13 @@ "operationId": "Volumes_Update", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VolumeNameParameter" @@ -6238,7 +5946,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, @@ -6251,6 +5959,27 @@ } }, "definitions": { + "AadConfiguration": { + "type": "object", + "title": "AadConfiguration represents the Azure Active Directory Integration properties.", + "required": [ + "adminGroupObjectIds" + ], + "properties": { + "adminGroupObjectIds": { + "description": "The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster.", + "type": "array", + "minItems": 1, + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, "AdministrativeCredentials": { "type": "object", "title": "AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication.", @@ -6272,27 +6001,489 @@ } } }, - "BareMetalMachine": { + "AdministratorConfiguration": { "type": "object", - "title": "BareMetalMachine represents the physical machine in the rack.", - "required": [ - "extendedLocation", - "properties" - ], + "title": "AdministratorConfiguration represents the administrative credentials that will be applied to the control plane and agent pool nodes in Kubernetes clusters.", "properties": { - "extendedLocation": { - "$ref": "#/definitions/ExtendedLocation", - "description": "The extended location of the cluster associated with the resource." + "adminUsername": { + "description": "The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] }, - "properties": { - "$ref": "#/definitions/BareMetalMachineProperties", - "description": "The list of the resource properties.", + "sshPublicKeys": { + "description": "The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.", + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + } + } + } + }, + "AdministratorConfigurationPatch": { + "type": "object", + "title": "AdministratorConfigurationPatch represents the patching capabilities for the administrator configuration.", + "properties": { + "sshPublicKeys": { + "description": "SshPublicKey represents the public key used to authenticate with a resource through SSH.", + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "keyData" + ] + } + } + }, + "AgentOptions": { + "type": "object", + "title": "AgentOptions are configurations that will be applied to each agent in an agent pool.", + "required": [ + "hugepagesCount" + ], + "properties": { + "hugepagesCount": { + "description": "The number of hugepages to allocate.", + "type": "integer", + "format": "int64" + }, + "hugepagesSize": { + "description": "The size of the hugepages to allocate.", + "type": "string", + "default": "2M", + "enum": [ + "2M", + "1G" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "HugepagesSize" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AgentPool": { + "type": "object", + "title": "AgentPool represents the agent pool of Kubernetes cluster.", + "required": [ + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/AgentPoolProperties", + "description": "The list of the resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "AgentPoolConfiguration": { + "type": "object", + "title": "AgentPoolConfiguration specifies the configuration of a pool of nodes.", + "required": [ + "count", + "mode", + "vmSkuName" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in this agent pool." + }, + "agentOptions": { + "$ref": "#/definitions/AgentOptions", + "description": "The configurations that will be applied to each agent in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64" + }, + "labels": { + "description": "The labels applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mode": { + "description": "The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "taints": { + "description": "The taints applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + }, + "vmSkuName": { + "description": "The name of the VM SKU that determines the size of resources allocated for node VMs.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AgentPoolList": { + "type": "object", + "title": "AgentPoolList represents a list of Kubernetes cluster agent pools.", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of agent pools.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + } + } + } + }, + "AgentPoolPatchParameters": { + "type": "object", + "title": "AgentPoolPatchParameters represents the body of the request to patch the Kubernetes cluster agent pool.", + "properties": { + "properties": { + "$ref": "#/definitions/AgentPoolPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AgentPoolPatchProperties": { + "type": "object", + "title": "AgentPoolPatchProperties represents the properties of an agent pool that can be modified.", + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/NodePoolAdministratorConfigurationPatch", + "description": "The configuration of administrator credentials for the control plane nodes." + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + } + } + }, + "AgentPoolProperties": { + "type": "object", + "title": "AgentPoolProperties represents the properties of the Kubernetes cluster agent pool.", + "required": [ + "count", + "mode", + "vmSkuName" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "agentOptions": { + "$ref": "#/definitions/AgentOptions", + "description": "The configurations that will be applied to each agent in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64" + }, + "detailedStatus": { + "description": "The current status of the agent pool.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "kubernetesVersion": { + "description": "The Kubernetes version running in this agent pool.", + "type": "string", + "readOnly": true + }, + "labels": { + "description": "The labels applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mode": { + "description": "The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "The provisioning state of the agent pool.", + "type": "string", + "enum": [ + "Accepted", + "Canceled", + "Deleting", + "Failed", + "InProgress", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolProvisioningState" + }, + "readOnly": true + }, + "taints": { + "description": "The taints applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + }, + "vmSkuName": { + "description": "The name of the VM SKU that determines the size of resources allocated for node VMs.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "title": "AgentPoolUpgradeSettings specifies the upgrade settings for an agent pool.", + "properties": { + "maxSurge": { + "description": "The maximum number or percentage of nodes that are surged during upgrade. 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.", + "type": "string", + "default": "1" + } + } + }, + "AttachedNetworkConfiguration": { + "type": "object", + "title": "AttachedNetworkConfiguration represents the set of workload networks to attach to a resource.", + "properties": { + "l2Networks": { + "description": "The list of Layer 2 Networks and related configuration for attachment.", + "type": "array", + "items": { + "$ref": "#/definitions/L2NetworkAttachmentConfiguration" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "l3Networks": { + "description": "The list of Layer 3 Networks and related configuration for attachment.", + "type": "array", + "items": { + "$ref": "#/definitions/L3NetworkAttachmentConfiguration" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "trunkedNetworks": { + "description": "The list of Trunked Networks and related configuration for attachment.", + "type": "array", + "items": { + "$ref": "#/definitions/TrunkedNetworkAttachmentConfiguration" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "AvailableUpgrade": { + "type": "object", + "title": "AvailableUpgrade represents an upgrade available for a Kubernetes cluster.", + "properties": { + "availabilityLifecycle": { + "description": "The version lifecycle indicator.", + "type": "string", + "enum": [ + "Preview", + "GenerallyAvailable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AvailabilityLifecycle" + }, + "readOnly": true + }, + "version": { + "description": "The version available for upgrading.", + "type": "string", + "readOnly": true + } + } + }, + "BareMetalMachine": { + "type": "object", + "title": "BareMetalMachine represents the physical machine in the rack.", + "required": [ + "extendedLocation", + "properties" + ], + "properties": { + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the cluster associated with the resource." + }, + "properties": { + "$ref": "#/definitions/BareMetalMachineProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -6410,7 +6601,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -6681,6 +6872,14 @@ "serialNumber" ], "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, "bmcConnectionString": { "description": "The connection string for the baseboard management controller including IP address and protocol.", "type": "string" @@ -6702,6 +6901,7 @@ "clusterId": { "description": "The resource ID of the cluster this bare metal machine is associated with.", "type": "string", + "format": "arm-id", "readOnly": true }, "cordonStatus": { @@ -6750,7 +6950,7 @@ "readOnly": true }, "hybridAksClustersAssociatedIds": { - "description": "The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine.", + "description": "Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine.", "type": "array", "items": { "type": "string" @@ -6777,6 +6977,14 @@ "type": "string", "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$" }, + "machineRoles": { + "description": "The list of roles that are assigned to the cluster node running on this machine.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, "machineSkuId": { "description": "The unique internal identifier of the bare metal machine SKU.", "type": "string" @@ -6827,7 +7035,15 @@ }, "rackId": { "description": "The resource ID of the rack where this bare metal machine resides.", - "type": "string" + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/racks" + } + ] + } }, "rackSlot": { "description": "The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1.", @@ -6849,6 +7065,11 @@ }, "readOnly": true }, + "runtimeProtectionStatus": { + "$ref": "#/definitions/RuntimeProtectionStatus", + "description": "The runtime protection status of the bare metal machine.", + "readOnly": true + }, "serialNumber": { "description": "The serial number of the bare metal machine.", "type": "string", @@ -6861,7 +7082,7 @@ "readOnly": true }, "virtualMachinesAssociatedIds": { - "description": "The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine.", + "description": "Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine.", "type": "array", "items": { "type": "string" @@ -6981,58 +7202,117 @@ } } }, - "BareMetalMachineValidateHardwareParameters": { + "BgpAdvertisement": { "type": "object", - "title": "BareMetalMachineValidateHardwareParameters represents the body of the request to validate the physical hardware of a bare metal machine.", + "title": "BgpAdvertisement represents the association of IP address pools to the communities and peers.", "required": [ - "validationCategory" + "ipAddressPools" ], "properties": { - "validationCategory": { - "description": "The category of hardware validation to perform.", + "advertiseToFabric": { + "description": "The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False.", "type": "string", + "default": "True", "enum": [ - "BasicValidation" + "True", + "False" ], "x-ms-enum": { "modelAsString": true, - "name": "BareMetalMachineHardwareValidationCategory" - } + "name": "AdvertiseToFabric" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "communities": { + "description": "The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipAddressPools": { + "description": "The names of the IP address pools associated with this announcement.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "peers": { + "description": "The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] } } }, - "BgpPeer": { + "BgpServiceLoadBalancerConfiguration": { "type": "object", - "title": "BgpPeer represents the IP address and ASN(Autonomous System Number) to peer with Hybrid AKS cluster.", - "required": [ - "peerIp", - "asNumber" - ], + "title": "BgpServiceLoadBalancerConfiguration represents the configuration of a BGP service load balancer.", "properties": { - "asNumber": { - "description": "The ASN (Autonomous System Number) of the BGP peer.", - "type": "integer", - "format": "int64", - "maximum": 4294967295, - "minimum": 0, + "bgpAdvertisements": { + "description": "The association of IP address pools to the communities and peers, allowing for announcement of IPs.", + "type": "array", + "items": { + "$ref": "#/definitions/BgpAdvertisement" + }, + "x-ms-identifiers": [], "x-ms-mutability": [ "read", "create" ] }, - "password": { - "description": "The password for this peering neighbor. It defaults to no password if not specified.", - "type": "string", - "maxLength": 80, - "pattern": "^[a-zA-Z0-9]{0,80}$", + "bgpPeers": { + "description": "The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadBalancerBgpPeer" + }, + "x-ms-identifiers": [], "x-ms-mutability": [ + "read", "create" - ], - "x-ms-secret": true + ] }, - "peerIp": { - "description": "The IPv4 or IPv6 address to peer with the associated CNI Network. The IP version type will drive a peering with the same version type from the Default CNI Network. For example, IPv4 to IPv4 or IPv6 to IPv6.", + "fabricPeeringEnabled": { + "description": "The indicator to specify if the load balancer peers with the network fabric.", "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "FabricPeeringEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ipAddressPools": { + "description": "The list of pools of IP addresses that can be allocated to Load Balancer services.", + "type": "array", + "items": { + "$ref": "#/definitions/IpAddressPool" + }, + "x-ms-identifiers": [], "x-ms-mutability": [ "read", "create" @@ -7060,7 +7340,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -7245,7 +7525,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -7324,9 +7604,18 @@ }, "x-ms-identifiers": [] }, + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, "clusterId": { "description": "The resource ID of the Network Cloud cluster this cloud services network is associated with.", "type": "string", + "format": "arm-id", "readOnly": true }, "detailedStatus": { @@ -7371,7 +7660,7 @@ "readOnly": true }, "hybridAksClustersAssociatedIds": { - "description": "The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.", + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this cloud services network.", "type": "array", "items": { "type": "string" @@ -7400,7 +7689,7 @@ "readOnly": true }, "virtualMachinesAssociatedIds": { - "description": "The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.", + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this cloud services network.", "type": "array", "items": { "type": "string" @@ -7429,7 +7718,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -7593,7 +7882,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -7638,6 +7927,14 @@ "analyticsWorkspaceId": { "description": "The resource ID of the Log Analytics workspace that is used for the logs collection.", "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, "x-ms-mutability": [ "read", "create" @@ -7691,6 +7988,7 @@ "fabricControllerId": { "description": "The resource ID of the fabric controller that has one to one mapping with the cluster manager.", "type": "string", + "format": "arm-id", "x-ms-mutability": [ "read", "create" @@ -7752,7 +8050,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -7925,6 +8223,18 @@ "x-ms-identifiers": [ "networkRackId" ] + }, + "runtimeProtectionConfiguration": { + "$ref": "#/definitions/RuntimeProtectionConfiguration", + "description": "The settings for cluster runtime protection." + }, + "secretArchive": { + "$ref": "#/definitions/ClusterSecretArchive", + "description": "The configuration for use of a key vault to store secrets for later retrieval by the operator." + }, + "updateStrategy": { + "$ref": "#/definitions/ClusterUpdateStrategy", + "description": "The strategy for updating the cluster." } } }, @@ -7934,7 +8244,6 @@ "required": [ "networkFabricId", "clusterType", - "analyticsWorkspaceId", "clusterVersion", "aggregatorOrSingleRackDefinition" ], @@ -7945,11 +8254,7 @@ }, "analyticsWorkspaceId": { "description": "The resource ID of the Log Analytics Workspace that will be used for storing relevant logs.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] + "type": "string" }, "availableUpgradeVersions": { "description": "The list of cluster runtime version upgrades available for this cluster.", @@ -7972,6 +8277,7 @@ "type": "string", "enum": [ "Connected", + "Disconnected", "Timeout", "Undefined" ], @@ -8007,6 +8313,14 @@ "clusterManagerId": { "description": "The resource ID of the cluster manager that manages this cluster. This is set by the Cluster Manager when the cluster is created.", "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/clusterManagers" + } + ] + }, "readOnly": true }, "clusterServicePrincipal": { @@ -8077,7 +8391,7 @@ }, "hybridAksExtendedLocation": { "$ref": "#/definitions/ExtendedLocation", - "description": "The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).", + "description": "Field Deprecated. This field will not be populated in an upcoming version. The extended location (custom location) that represents the Hybrid AKS control plane location. This extended location is used when creating provisioned clusters (Hybrid AKS clusters).", "readOnly": true }, "managedResourceGroupConfiguration": { @@ -8093,6 +8407,7 @@ "networkFabricId": { "description": "The resource ID of the Network Fabric associated with the cluster.", "type": "string", + "format": "arm-id", "x-ms-mutability": [ "read", "create" @@ -8115,11 +8430,23 @@ }, "readOnly": true }, + "runtimeProtectionConfiguration": { + "$ref": "#/definitions/RuntimeProtectionConfiguration", + "description": "The settings for cluster runtime protection." + }, + "secretArchive": { + "$ref": "#/definitions/ClusterSecretArchive", + "description": "The configuration for use of a key vault to store secrets for later retrieval by the operator." + }, "supportExpiryDate": { "description": "The support end date of the runtime version of the cluster.", "type": "string", "readOnly": true }, + "updateStrategy": { + "$ref": "#/definitions/ClusterUpdateStrategy", + "description": "The strategy for updating the cluster." + }, "workloadResourceIds": { "description": "The list of workload resource IDs that are hosted within this cluster.", "type": "array", @@ -8130,109 +8457,123 @@ } } }, - "ClusterUpdateVersionParameters": { + "ClusterScanRuntimeParameters": { + "type": "object", + "title": "ClusterScanRuntimeParameters defines the parameters for the cluster scan runtime operation.", + "properties": { + "scanActivity": { + "description": "The choice of if the scan operation should run the scan.", + "type": "string", + "default": "Scan", + "enum": [ + "Scan", + "Skip" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterScanRuntimeParametersScanActivity" + } + } + } + }, + "ClusterSecretArchive": { "type": "object", - "title": "ClusterUpdateVersionParameters represents the body of the request to update cluster version.", + "title": "ClusterSecretArchive configures the key vault to archive the secrets of the cluster for later retrieval.", "required": [ - "targetClusterVersion" + "keyVaultId" ], "properties": { - "targetClusterVersion": { - "description": "The version to be applied to the cluster during update.", - "type": "string" + "keyVaultId": { + "description": "The resource ID of the key vault to archive the secrets of the cluster.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "useKeyVault": { + "description": "The indicator if the specified key vault should be used to archive the secrets of the cluster.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterSecretArchiveEnabled" + } } } }, - "CniBgpConfiguration": { + "ClusterUpdateStrategy": { "type": "object", - "title": "CniBgpConfiguration represents the Calico BGP configuration.", + "title": "ClusterUpdateStrategy represents the strategy for updating the cluster.", + "required": [ + "strategyType", + "thresholdType", + "thresholdValue" + ], "properties": { - "bgpPeers": { - "description": "The list of BgpPeer entities that the Hybrid AKS cluster will peer with in addition to peering that occurs automatically with the switch fabric.", - "type": "array", - "items": { - "$ref": "#/definitions/BgpPeer" - }, - "x-ms-identifiers": [ - "peerIp" - ], - "x-ms-mutability": [ - "read", - "create" - ] + "maxUnavailable": { + "description": "The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack.\nLimited by the maximum number of machines in the increment. Defaults to the whole increment size.", + "type": "integer", + "format": "int64", + "minimum": 1 }, - "communityAdvertisements": { - "description": "The list of prefix community advertisement properties. Each prefix community specifies a prefix, and the\ncommunities that should be associated with that prefix when it is announced.", - "type": "array", - "items": { - "$ref": "#/definitions/CommunityAdvertisement" - }, - "x-ms-identifiers": [], - "x-ms-mutability": [ - "read", - "create" - ] + "strategyType": { + "description": "The mode of operation for runtime protection.", + "type": "string", + "enum": [ + "Rack" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ClusterUpdateStrategyType" + } }, - "nodeMeshPassword": { - "description": "The password of the Calico node mesh. It defaults to a randomly-generated string when not provided.", + "thresholdType": { + "description": "Selection of how the threshold should be evaluated.", "type": "string", - "maxLength": 80, - "pattern": "^[a-zA-Z0-9]{0,80}$", - "x-ms-mutability": [ - "create" + "enum": [ + "CountSuccess", + "PercentSuccess" ], - "x-ms-secret": true + "x-ms-enum": { + "modelAsString": true, + "name": "ValidationThresholdType" + } }, - "serviceExternalPrefixes": { - "description": "The subnet blocks in CIDR format for Kubernetes service external IPs to be advertised over BGP.", - "type": "array", - "items": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create" - ] + "thresholdValue": { + "description": "The numeric threshold value.", + "type": "integer", + "format": "int64", + "minimum": 0 }, - "serviceLoadBalancerPrefixes": { - "description": "The subnet blocks in CIDR format for Kubernetes load balancers. Load balancer IPs will only be advertised if they\nare within one of these blocks.", - "type": "array", - "items": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create" - ] + "waitTimeMinutes": { + "description": "The time to wait between the increments of update defined by the strategy.", + "type": "integer", + "format": "int64", + "default": 15, + "maximum": 60, + "minimum": 0 } } }, - "CommunityAdvertisement": { + "ClusterUpdateVersionParameters": { "type": "object", - "title": "CommunityAdvertisement represents the prefix and the communities that should be associated with that prefix.", + "title": "ClusterUpdateVersionParameters represents the body of the request to update cluster version.", "required": [ - "subnetPrefix", - "communities" + "targetClusterVersion" ], "properties": { - "communities": { - "description": "The list of community strings to announce with this prefix.", - "type": "array", - "items": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create" - ] - }, - "subnetPrefix": { - "description": "The subnet in CIDR format for which properties should be advertised.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] + "targetClusterVersion": { + "description": "The version to be applied to the cluster during update.", + "type": "string" } } }, @@ -8256,7 +8597,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -8301,7 +8642,7 @@ "title": "ConsolePatchProperties represents the properties of the virtual machine console that can be patched.", "properties": { "enabled": { - "description": "The credentials used to login to the image repository that has access to the specified image.", + "description": "The indicator of whether the console access is enabled.", "type": "string", "enum": [ "True", @@ -8369,6 +8710,14 @@ "privateLinkServiceId": { "description": "The resource ID of the private link service that is used to provide virtual machine console access.", "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateLinkServices" + } + ] + }, "readOnly": true }, "provisioningState": { @@ -8398,195 +8747,42 @@ } } }, - "DefaultCniNetwork": { - "type": "object", - "title": "DefaultCniNetwork represents the user-managed portions of the default CNI (pod) network that is created in support of a Hybrid AKS Cluster.", - "required": [ - "extendedLocation", - "properties" - ], - "properties": { - "extendedLocation": { - "$ref": "#/definitions/ExtendedLocation", - "description": "The extended location of the cluster associated with the resource." - }, - "properties": { - "$ref": "#/definitions/DefaultCniNetworkProperties", - "description": "The list of the resource properties.", - "x-ms-client-flatten": true - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "x-ms-azure-resource": true - }, - "DefaultCniNetworkList": { - "type": "object", - "title": "DefaultCniNetworkList represents a list of default CNI networks.", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The list of default CNI networks.", - "type": "array", - "items": { - "$ref": "#/definitions/DefaultCniNetwork" - } - } - } - }, - "DefaultCniNetworkPatchParameters": { - "type": "object", - "title": "DefaultCniNetworkPatchParameters represents the body of the request to patch the Default CNI network.", - "properties": { - "tags": { - "description": "The Azure resource tags that will replace the existing ones.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "DefaultCniNetworkProperties": { + "ControlPlaneNodeConfiguration": { "type": "object", - "title": "DefaultCniNetworkProperties represents properties of the default CNI network.", + "title": "ControlPlaneNodeConfiguration represents the selection of virtual machines and size of the control plane for a Kubernetes cluster.", "required": [ - "l3IsolationDomainId", - "vlan" + "count", + "vmSkuName" ], "properties": { - "clusterId": { - "description": "The resource ID of the Network Cloud cluster this default CNI network is associated with.", - "type": "string", - "readOnly": true - }, - "cniAsNumber": { - "description": "The autonomous system number that the fabric expects to peer with, derived from the associated L3 isolation domain.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "cniBgpConfiguration": { - "$ref": "#/definitions/CniBgpConfiguration", - "description": "The Calico BGP configuration.", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "detailedStatus": { - "description": "The more detailed status of the default CNI network.", - "type": "string", - "enum": [ - "Error", - "Available", - "Provisioning" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "DefaultCniNetworkDetailedStatus" - }, - "readOnly": true - }, - "detailedStatusMessage": { - "description": "The descriptive message about the current detailed status.", - "type": "string", - "readOnly": true - }, - "fabricBgpPeers": { - "description": "The L3 isolation fabric BGP peering connectivity information necessary for BGP peering the Hybrid AKS Cluster with the switch fabric.", - "type": "array", - "items": { - "$ref": "#/definitions/BgpPeer" - }, - "x-ms-identifiers": [ - "peerIp" - ], - "readOnly": true - }, - "hybridAksClustersAssociatedIds": { - "description": "The list of Hybrid AKS cluster resource ID(s) that are associated with this default CNI network.", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "interfaceName": { - "description": "The name of the interface that will be present in the virtual machine to represent this network.", - "type": "string", - "readOnly": true - }, - "ipAllocationType": { - "description": "The type of the IP address allocation.", - "type": "string", - "default": "DualStack", - "enum": [ - "IPV4", - "IPV6", - "DualStack" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "IpAllocationType" - }, - "x-ms-mutability": [ - "read", - "create" - ] - }, - "ipv4ConnectedPrefix": { - "description": "The IPV4 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type\nis IPV4 or DualStack.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "ipv6ConnectedPrefix": { - "description": "The IPV6 prefix (CIDR) assigned to this default CNI network. It is required when the IP allocation type\nis IPV6 or DualStack.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "l3IsolationDomainId": { - "description": "The resource ID of the Network Fabric l3IsolationDomain.", - "type": "string", + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in the control plane.", "x-ms-mutability": [ "read", "create" ] }, - "provisioningState": { - "description": "The provisioning state of the default CNI network.", - "type": "string", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Provisioning", - "Accepted" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "DefaultCniNetworkProvisioningState" + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" }, - "readOnly": true + "x-ms-mutability": [ + "read", + "create" + ] }, - "vlan": { - "description": "The VLAN from the l3IsolationDomain that is used for this network.", + "count": { + "description": "The number of virtual machines that use this configuration.", "type": "integer", "format": "int64", - "maximum": 4094, - "minimum": 1, + "minimum": 1 + }, + "vmSkuName": { + "description": "The name of the VM SKU supplied during creation.", + "type": "string", "x-ms-mutability": [ "read", "create" @@ -8594,6 +8790,22 @@ } } }, + "ControlPlaneNodePatchConfiguration": { + "type": "object", + "title": "ControlPlaneNodePatchConfiguration represents the properties of the control plane that can be patched for this Kubernetes cluster.", + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfigurationPatch", + "description": "The configuration of administrator credentials for the control plane nodes." + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64", + "minimum": 1 + } + } + }, "EgressEndpoint": { "type": "object", "title": "EgressEndpoint represents the connection from a cloud services network to the specified endpoint for a common purpose.", @@ -8663,6 +8875,41 @@ } } }, + "FeatureStatus": { + "type": "object", + "title": "FeatureStatus contains information regarding a Kubernetes cluster feature.", + "properties": { + "detailedStatus": { + "description": "The status representing the state of this feature.", + "type": "string", + "enum": [ + "Running", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "FeatureDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the feature.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version of the feature.", + "type": "string", + "readOnly": true + } + } + }, "HardwareInventory": { "type": "object", "title": "HardwareInventory represents the hardware configuration of this machine as exposed to the customer, including information acquired from the model/sku information and from the ironic inspector.", @@ -8736,21 +8983,283 @@ "description": "The outcome of the hardware validation.", "type": "string", "enum": [ - "Pass", - "Fail" + "Pass", + "Fail" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BareMetalMachineHardwareValidationResult" + }, + "readOnly": true + } + } + }, + "ImageRepositoryCredentials": { + "type": "object", + "title": "ImageRepositoryCredentials represents the credentials used to login to the image repository.", + "required": [ + "username", + "password", + "registryUrl" + ], + "properties": { + "password": { + "description": "The password or token used to access an image in the target repository.", + "type": "string", + "minLength": 1, + "x-ms-secret": true + }, + "registryUrl": { + "description": "The URL of the authentication server used to validate the repository credentials.", + "type": "string" + }, + "username": { + "description": "The username used to access an image in the target repository.", + "type": "string", + "minLength": 1 + } + } + }, + "InitialAgentPoolConfiguration": { + "type": "object", + "title": "InitialAgentPoolConfiguration specifies the configuration of a pool of virtual machines that are initially defined with a Kubernetes cluster.", + "required": [ + "count", + "mode", + "vmSkuName", + "name" + ], + "properties": { + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrator credentials to be used for the nodes in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "agentOptions": { + "$ref": "#/definitions/AgentOptions", + "description": "The configurations that will be applied to each agent in this agent pool.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "availabilityZones": { + "description": "The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "count": { + "description": "The number of virtual machines that use this configuration.", + "type": "integer", + "format": "int64", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "labels": { + "description": "The labels applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "mode": { + "description": "The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.", + "type": "string", + "enum": [ + "System", + "User", + "NotApplicable" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "AgentPoolMode" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name that will be used for the agent pool resource representing this agent pool.", + "type": "string", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "taints": { + "description": "The taints applied to the nodes in this agent pool.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesLabel" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "The configuration of the agent pool." + }, + "vmSkuName": { + "description": "The name of the VM SKU that determines the size of resources allocated for node VMs.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "IpAddressPool": { + "type": "object", + "title": "IpAddressPool represents a pool of IP addresses that can be allocated to a service.", + "required": [ + "addresses", + "name" + ], + "properties": { + "addresses": { + "description": "The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "autoAssign": { + "description": "The indicator to determine if automatic allocation from the pool should occur.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BfdEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name used to identify this IP address pool for association with a BGP advertisement.", + "type": "string", + "pattern": "^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "onlyUseHostIps": { + "description": "The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive.", + "type": "string", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BfdEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "KeySetUser": { + "type": "object", + "title": "KeySetUser represents the properties of the user in the key set.", + "required": [ + "azureUserName", + "sshPublicKey" + ], + "properties": { + "azureUserName": { + "description": "The user name that will be used for access.", + "type": "string" + }, + "description": { + "description": "The free-form description for this user.", + "type": "string", + "maxLength": 256 + }, + "sshPublicKey": { + "$ref": "#/definitions/SshPublicKey", + "description": "The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in." + }, + "userPrincipalName": { + "description": "The user principal name (email format) used to validate this user's group membership.", + "type": "string" + } + } + }, + "KeySetUserStatus": { + "type": "object", + "title": "KeySetUserStatus represents the status of the key set user.", + "properties": { + "azureUserName": { + "description": "The user name that will be used for access.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The indicator of whether the user is currently deployed for access.", + "type": "string", + "enum": [ + "Active", + "Invalid" ], "x-ms-enum": { "modelAsString": true, - "name": "BareMetalMachineHardwareValidationResult" + "name": "BareMetalMachineKeySetUserSetupStatus" }, "readOnly": true + }, + "statusMessage": { + "description": "The additional information describing the current status of this user, if any available.", + "type": "string", + "maxLength": 256, + "readOnly": true } } }, - "HybridAksCluster": { - "description": "The details are specific to the Network Cloud use of the Hybrid AKS cluster.", + "KubernetesCluster": { "type": "object", - "title": "HybridAksCluster represents the additional details regarding the Hybrid AKS cluster.", + "title": "KubernetesCluster represents the Kubernetes cluster hosted on Network Cloud.", "required": [ "extendedLocation", "properties" @@ -8761,249 +9270,433 @@ "description": "The extended location of the cluster associated with the resource." }, "properties": { - "$ref": "#/definitions/HybridAksClusterProperties", + "$ref": "#/definitions/KubernetesClusterProperties", "description": "The list of the resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true }, - "HybridAksClusterList": { + "KubernetesClusterList": { "type": "object", - "title": "HybridAksClusterList represents a list of Hybrid AKS clusters.", + "title": "KubernetesClusterList represents a list of Kubernetes clusters.", "properties": { "nextLink": { "description": "The link used to get the next page of operations.", "type": "string" }, "value": { - "description": "The list of additional details related to Hybrid AKS clusters.", + "description": "The list of additional details related to Kubernetes clusters.", "type": "array", "items": { - "$ref": "#/definitions/HybridAksCluster" - } - } - } - }, - "HybridAksClusterPatchParameters": { - "type": "object", - "title": "HybridAksClusterPatchParameters represents the body of the request to patch the Hybrid AKS cluster.", - "properties": { - "tags": { - "description": "The Azure resource tags that will replace the existing ones.", - "type": "object", - "additionalProperties": { - "type": "string" + "$ref": "#/definitions/KubernetesCluster" } } } }, - "HybridAksClusterProperties": { + "KubernetesClusterNode": { "type": "object", - "title": "HybridAksClusterProperties represents the properties of Hybrid AKS cluster resource.", - "required": [ - "hybridAksProvisionedClusterId", - "associatedNetworkIds", - "controlPlaneCount", - "workerCount" - ], + "title": "KubernetesClusterNode represents the details of a node in a Kubernetes cluster.", "properties": { - "associatedNetworkIds": { - "description": "The list of resource IDs for the workload networks associated with the Hybrid AKS cluster. It can be any of l2Networks, l3Networks, or trunkedNetworks resources. This field will also contain one cloudServicesNetwork and one defaultCniNetwork.", - "type": "array", - "items": { - "type": "string" - } + "agentPoolId": { + "description": "The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/kubernetesClusters/agentPools" + } + ] + }, + "readOnly": true }, - "cloudServicesNetworkId": { - "description": "The resource ID of the associated cloud services network.", + "availabilityZone": { + "description": "The availability zone this node is running within.", "type": "string", "readOnly": true }, - "clusterId": { - "description": "The resource ID of the Network Cloud cluster hosting the Hybrid AKS cluster.", + "bareMetalMachineId": { + "description": "The resource ID of the bare metal machine that hosts this node.", "type": "string", + "format": "arm-id", "readOnly": true }, - "controlPlaneCount": { - "description": "The number of control plane node VMs.", + "cpuCores": { + "description": "The number of CPU cores configured for this node, derived from the VM SKU specified.", "type": "integer", "format": "int64", - "minimum": 1 + "readOnly": true + }, + "detailedStatus": { + "description": "The detailed state of this node.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning", + "Running", + "Scheduling", + "Stopped", + "Terminating", + "Unknown" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterNodeDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "diskSizeGB": { + "description": "The size of the disk configured for this node.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "image": { + "description": "The machine image used to deploy this node.", + "type": "string", + "readOnly": true + }, + "kubernetesVersion": { + "description": "The currently running version of Kubernetes and bundled features running on this node.", + "type": "string", + "readOnly": true }, - "controlPlaneNodes": { - "description": "The list of node configurations detailing associated VMs that are part of the control plane nodes of this Hybrid AKS cluster.", + "labels": { + "description": "The list of labels on this node that have been assigned to the agent pool containing this node.", "type": "array", "items": { - "$ref": "#/definitions/NodeConfiguration" + "$ref": "#/definitions/KubernetesLabel" }, "x-ms-identifiers": [ - "nodePoolName" + "key" ], "readOnly": true }, - "defaultCniNetworkId": { - "description": "The resource ID of the associated default CNI network.", - "type": "string", + "memorySizeGB": { + "description": "The amount of memory configured for this node, derived from the vm SKU specified.", + "type": "integer", + "format": "int64", "readOnly": true }, - "detailedStatus": { - "description": "The more detailed status of this Hybrid AKS cluster.", + "mode": { + "description": "The mode of the agent pool containing this node. Not applicable for control plane nodes.", "type": "string", "enum": [ - "Error", - "Available", - "Provisioning" + "System", + "User", + "NotApplicable" ], "x-ms-enum": { "modelAsString": true, - "name": "HybridAksClusterDetailedStatus" + "name": "AgentPoolMode" }, "readOnly": true }, - "detailedStatusMessage": { - "description": "The descriptive message about the current detailed status.", + "name": { + "description": "The name of this node, as realized in the Kubernetes cluster.", "type": "string", "readOnly": true }, - "hybridAksProvisionedClusterId": { - "description": "The resource ID of the Hybrid AKS cluster that this additional information is for.", - "type": "string" + "networkAttachments": { + "description": "The NetworkAttachments made to this node.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAttachment" + }, + "x-ms-identifiers": [ + "networkAttachmentName" + ], + "readOnly": true }, - "provisioningState": { - "description": "The provisioning state of the Hybrid AKS cluster resource.", + "powerState": { + "description": "The power state of this node.", "type": "string", "enum": [ - "Succeeded", - "Failed", - "Canceled" + "On", + "Off", + "Unknown" ], "x-ms-enum": { "modelAsString": true, - "name": "HybridAksClusterProvisioningState" + "name": "KubernetesNodePowerState" }, "readOnly": true }, - "volumes": { - "description": "The resource IDs of volumes that are attached to the Hybrid AKS cluster.", - "type": "array", - "items": { - "type": "string" + "role": { + "description": "The role of this node in the cluster.", + "type": "string", + "enum": [ + "ControlPlane", + "Worker" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesNodeRole" }, "readOnly": true }, - "workerCount": { - "description": "The number of worker node VMs.", - "type": "integer", - "format": "int64" - }, - "workerNodes": { - "description": "The list of node configurations detailing associated VMs that are part of the worker nodes of this Hybrid AKS cluster.", + "taints": { + "description": "The list of taints that have been assigned to the agent pool containing this node.", "type": "array", "items": { - "$ref": "#/definitions/NodeConfiguration" + "$ref": "#/definitions/KubernetesLabel" }, "x-ms-identifiers": [ - "nodePoolName" + "key" ], "readOnly": true + }, + "vmSkuName": { + "description": "The VM SKU name that was used to create this cluster node.", + "type": "string", + "readOnly": true } } }, - "HybridAksClusterRestartNodeParameters": { + "KubernetesClusterPatchParameters": { "type": "object", - "title": "HybridAksClusterRestartNodeParameters represents the body of the request to restart the node of a Hybrid AKS cluster.", - "required": [ - "nodeName" - ], + "title": "KubernetesClusterPatchParameters represents the body of the request to patch the Hybrid AKS cluster.", "properties": { - "nodeName": { - "description": "The name of the node to restart.", - "type": "string" + "properties": { + "$ref": "#/definitions/KubernetesClusterPatchProperties", + "description": "The list of the resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "The Azure resource tags that will replace the existing ones.", + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, - "ImageRepositoryCredentials": { + "KubernetesClusterPatchProperties": { "type": "object", - "title": "ImageRepositoryCredentials represents the credentials used to login to the image repository.", - "required": [ - "username", - "password", - "registryUrl" - ], + "title": "KubernetesClusterPatchProperties represents the properties of the Kubernetes cluster that can be patched.", "properties": { - "password": { - "description": "The password or token used to access an image in the target repository.", - "type": "string", - "minLength": 1, - "x-ms-secret": true + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfigurationPatch", + "description": "The configuration of the default administrator credentials." }, - "registryUrl": { - "description": "The URL of the authentication server used to validate the repository credentials.", - "type": "string" + "controlPlaneNodeConfiguration": { + "$ref": "#/definitions/ControlPlaneNodePatchConfiguration", + "description": "The defining characteristics of the control plane that can be patched for this Kubernetes cluster." }, - "username": { - "description": "The username used to access an image in the target repository.", - "type": "string", - "minLength": 1 + "kubernetesVersion": { + "description": "The Kubernetes version for this cluster. Accepts n.n, n.n.n, and n.n.n-n format. The interpreted version used will be resolved into this field after creation or update.", + "type": "string" } } }, - "KeySetUser": { + "KubernetesClusterProperties": { "type": "object", - "title": "KeySetUser represents the properties of the user in the key set.", + "title": "KubernetesClusterProperties represents the properties of Kubernetes cluster resource.", "required": [ - "azureUserName", - "sshPublicKey" + "initialAgentPoolConfigurations", + "controlPlaneNodeConfiguration", + "kubernetesVersion", + "networkConfiguration" ], "properties": { - "azureUserName": { - "description": "The Azure Active Directory user name (email name).", - "type": "string" + "aadConfiguration": { + "$ref": "#/definitions/AadConfiguration", + "description": "The Azure Active Directory Integration properties.", + "x-ms-mutability": [ + "read", + "create" + ] }, - "description": { - "description": "The free-form description for this user.", + "administratorConfiguration": { + "$ref": "#/definitions/AdministratorConfiguration", + "description": "The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values." + }, + "attachedNetworkIds": { + "description": "The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "availableUpgrades": { + "description": "The list of versions that this Kubernetes cluster can be upgraded to.", + "type": "array", + "items": { + "$ref": "#/definitions/AvailableUpgrade" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "clusterId": { + "description": "The resource ID of the Network Cloud cluster.", "type": "string", - "maxLength": 256 + "format": "arm-id", + "readOnly": true }, - "sshPublicKey": { - "$ref": "#/definitions/SshPublicKey", - "description": "The SSH public key for this user." - } - } - }, - "KeySetUserStatus": { - "type": "object", - "title": "KeySetUserStatus represents the status of the key set user.", - "properties": { - "azureUserName": { - "description": "The Azure Active Directory user name (email name).", + "connectedClusterId": { + "description": "The resource ID of the connected cluster set up when this Kubernetes cluster is created.", "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Kubernetes/connectedClusters" + } + ] + }, "readOnly": true }, - "status": { - "description": "The indicator of whether the user is currently deployed for access.", + "controlPlaneKubernetesVersion": { + "description": "The current running version of Kubernetes on the control plane.", + "type": "string", + "readOnly": true + }, + "controlPlaneNodeConfiguration": { + "$ref": "#/definitions/ControlPlaneNodeConfiguration", + "description": "The defining characteristics of the control plane for this Kubernetes Cluster." + }, + "detailedStatus": { + "description": "The current status of the Kubernetes cluster.", + "type": "string", + "enum": [ + "Available", + "Error", + "Provisioning" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesClusterDetailedStatus" + }, + "readOnly": true + }, + "detailedStatusMessage": { + "description": "The descriptive message about the current detailed status.", + "type": "string", + "readOnly": true + }, + "featureStatuses": { + "description": "The current feature settings.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureStatus" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "initialAgentPoolConfigurations": { + "description": "The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/InitialAgentPoolConfiguration" + }, + "x-ms-identifiers": [ + "name" + ], + "x-ms-mutability": [ + "read", + "create" + ] + }, + "kubernetesVersion": { + "description": "The Kubernetes version for this cluster. Accepts n.n, n.n.n, and n.n.n-n format. The interpreted version used will be resolved into this field after creation or update.", + "type": "string" + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "The configuration of the managed resource group associated with the resource." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "nodes": { + "description": "The details of the nodes in this cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/KubernetesClusterNode" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the Kubernetes cluster resource.", "type": "string", "enum": [ - "Active", - "Invalid" + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "InProgress", + "Created", + "Updating", + "Deleting" ], "x-ms-enum": { "modelAsString": true, - "name": "BareMetalMachineKeySetUserSetupStatus" + "name": "KubernetesClusterProvisioningState" }, "readOnly": true + } + } + }, + "KubernetesClusterRestartNodeParameters": { + "type": "object", + "title": "KubernetesClusterRestartNodeParameters represents the body of the request to restart the node of a Kubernetes cluster.", + "required": [ + "nodeName" + ], + "properties": { + "nodeName": { + "description": "The name of the node to restart.", + "type": "string" + } + } + }, + "KubernetesLabel": { + "type": "object", + "title": "KubernetesLabel represents a single entry for a Kubernetes label or taint such as those used on a node or pod.", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "description": "The name of the label or taint.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] }, - "statusMessage": { - "description": "The additional information describing the current status of this user, if any available.", + "value": { + "description": "The value of the label or taint.", "type": "string", - "maxLength": 256, - "readOnly": true + "x-ms-mutability": [ + "read", + "create" + ] } } }, @@ -9027,11 +9720,56 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true }, + "L2NetworkAttachmentConfiguration": { + "type": "object", + "title": "L2NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 2 network.", + "required": [ + "networkId" + ], + "properties": { + "networkId": { + "description": "The resource ID of the network that is being configured for attachment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/l2Networks" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "pluginType": { + "description": "The indicator of how this network will be utilized by the Kubernetes cluster.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice", + "MACVLAN", + "IPVLAN" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, "L2NetworkList": { "type": "object", "title": "L2NetworkList represents a list of L2 networks.", @@ -9069,9 +9807,18 @@ "l2IsolationDomainId" ], "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, "clusterId": { "description": "The resource ID of the Network Cloud cluster this L2 network is associated with.", "type": "string", + "format": "arm-id", "readOnly": true }, "detailedStatus": { @@ -9094,7 +9841,7 @@ "readOnly": true }, "hybridAksClustersAssociatedIds": { - "description": "The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network.", + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource ID(s) that are associated with this L2 network.", "type": "array", "items": { "type": "string" @@ -9102,7 +9849,7 @@ "readOnly": true }, "hybridAksPluginType": { - "description": "The network plugin type for Hybrid AKS.", + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.", "type": "string", "default": "SRIOV", "enum": [ @@ -9132,6 +9879,7 @@ "l2IsolationDomainId": { "description": "The resource ID of the Network Fabric l2IsolationDomain.", "type": "string", + "format": "arm-id", "x-ms-mutability": [ "read", "create" @@ -9154,7 +9902,7 @@ "readOnly": true }, "virtualMachinesAssociatedIds": { - "description": "The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network.", + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource ID(s), excluding any Hybrid AKS virtual machines, that are currently using this L2 network.", "type": "array", "items": { "type": "string" @@ -9183,11 +9931,73 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true }, + "L3NetworkAttachmentConfiguration": { + "type": "object", + "title": "L3NetworkAttachmentConfiguration represents the configuration of the attachment of a Layer 3 network.", + "required": [ + "networkId" + ], + "properties": { + "ipamEnabled": { + "description": "The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "L3NetworkConfigurationIpamEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkId": { + "description": "The resource ID of the network that is being configured for attachment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/l3Networks" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "pluginType": { + "description": "The indicator of how this network will be utilized by the Kubernetes cluster.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice", + "MACVLAN", + "IPVLAN" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, "L3NetworkList": { "type": "object", "title": "L3NetworkList represents a list of L3 networks.", @@ -9226,9 +10036,18 @@ "vlan" ], "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, "clusterId": { "description": "The resource ID of the Network Cloud cluster this L3 network is associated with.", "type": "string", + "format": "arm-id", "readOnly": true }, "detailedStatus": { @@ -9251,7 +10070,7 @@ "readOnly": true }, "hybridAksClustersAssociatedIds": { - "description": "The list of Hybrid AKS cluster resource IDs that are associated with this L3 network.", + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this L3 network.", "type": "array", "items": { "type": "string" @@ -9259,7 +10078,7 @@ "readOnly": true }, "hybridAksIpamEnabled": { - "description": "The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.", + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The indicator of whether or not to disable IPAM allocation on the network attachment definition injected into the Hybrid AKS Cluster.", "type": "string", "default": "True", "enum": [ @@ -9276,7 +10095,7 @@ ] }, "hybridAksPluginType": { - "description": "The network plugin type for Hybrid AKS.", + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.", "type": "string", "default": "SRIOV", "enum": [ @@ -9336,6 +10155,7 @@ "l3IsolationDomainId": { "description": "The resource ID of the Network Fabric l3IsolationDomain.", "type": "string", + "format": "arm-id", "x-ms-mutability": [ "read", "create" @@ -9358,7 +10178,7 @@ "readOnly": true }, "virtualMachinesAssociatedIds": { - "description": "The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.", + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this L3 network.", "type": "array", "items": { "type": "string" @@ -9573,6 +10393,7 @@ "attachedNetworkId": { "description": "The resource ID of the associated network attached to the virtual machine.\nIt can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources.", "type": "string", + "format": "arm-id", "x-ms-mutability": [ "read", "create" @@ -9639,6 +10460,80 @@ } } }, + "NetworkConfiguration": { + "type": "object", + "title": "NetworkConfiguration specifies the Kubernetes cluster network related configuration.", + "required": [ + "cloudServicesNetworkId", + "cniNetworkId" + ], + "properties": { + "attachedNetworkConfiguration": { + "$ref": "#/definitions/AttachedNetworkConfiguration", + "description": "The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "bgpServiceLoadBalancerConfiguration": { + "$ref": "#/definitions/BgpServiceLoadBalancerConfiguration", + "description": "The configuration of the BGP service load balancer for this Kubernetes cluster.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cloudServicesNetworkId": { + "description": "The resource ID of the associated Cloud Services network.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cniNetworkId": { + "description": "The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network.", + "type": "string", + "format": "arm-id", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "dnsServiceIp": { + "description": "The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "podCidrs": { + "description": "The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "serviceCidrs": { + "description": "The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, "NetworkInterface": { "type": "object", "title": "NetworkInterface represents properties of the network interface.", @@ -9711,109 +10606,19 @@ } } }, - "Node": { - "type": "object", - "title": "Node denotes the list of node that utilizes configuration.", - "properties": { - "bareMetalMachineId": { - "description": "The resource ID of the bare metal machine that hosts this node.", - "type": "string", - "readOnly": true - }, - "imageId": { - "description": "The machine image last used to deploy this node.", - "type": "string", - "readOnly": true - }, - "networkAttachments": { - "description": "The list of network attachments to the virtual machine.", - "type": "array", - "items": { - "$ref": "#/definitions/NetworkAttachment" - }, - "x-ms-identifiers": [ - "networkAttachmentName" - ], - "readOnly": true - }, - "nodeName": { - "description": "The name of this node, as realized in the Hybrid AKS cluster.", - "type": "string", - "readOnly": true - }, - "powerState": { - "description": "The power state (On | Off) of the node.", - "type": "string", - "enum": [ - "On", - "Off" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "HybridAksClusterMachinePowerState" - }, - "readOnly": true - } - } - }, - "NodeConfiguration": { + "NodePoolAdministratorConfigurationPatch": { "type": "object", - "title": "NodeConfiguration contains configuration for a VM associated with a node.", + "title": "NodePoolAdministratorConfigurationPatch represents the patching capabilities for the administrator configuration.", "properties": { - "agentPoolId": { - "description": "The resource ID of the agent pool that contains the nodes in this configuration.", - "type": "string", - "readOnly": true - }, - "agentPoolName": { - "description": "The name of the agent pool that contains the nodes in this configuration.", - "type": "string", - "readOnly": true - }, - "cpuCores": { - "description": "The number of CPU cores in the virtual machine.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "diskSizeGB": { - "description": "The root disk size of the virtual machine in GB.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "memorySizeGB": { - "description": "The memory size of the virtual machine in GB.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "nodePoolName": { - "description": "Field deprecated, use agentPoolName instead. This field will be removed in a future version but will reflect the name of the agent pool that contains the nodes in this configuration.", - "type": "string", - "readOnly": true - }, - "nodes": { - "description": "The list of nodes that utilize this configuration.", + "sshPublicKeys": { + "description": "SshPublicKey represents the public key used to authenticate with a resource through SSH.", "type": "array", "items": { - "$ref": "#/definitions/Node" + "$ref": "#/definitions/SshPublicKey" }, - "x-ms-identifiers": [ - "nodeName" - ], - "readOnly": true - }, - "vmCount": { - "description": "The number of virtual machines that use this configuration.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "vmSize": { - "description": "The name of the VM size supplied during the creation of the cluster.", - "type": "string", - "readOnly": true + "x-ms-identifiers": [ + "keyData" + ] } } }, @@ -9875,7 +10680,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -9890,7 +10695,7 @@ ], "properties": { "availabilityZone": { - "description": "The zone name used for this rack when created.", + "description": "The zone name used for this rack when created. Availability zones are used for workload placement.", "type": "string", "pattern": "^[a-zA-Z0-9]{1,10}$" }, @@ -9904,7 +10709,8 @@ }, "networkRackId": { "description": "The resource ID of the network rack that matches this rack definition.", - "type": "string" + "type": "string", + "format": "arm-id" }, "rackLocation": { "description": "The free-form description of the rack's location.", @@ -9919,7 +10725,15 @@ }, "rackSkuId": { "description": "The resource ID of the sku for the rack being added.", - "type": "string" + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/rackSkus" + } + ] + } }, "storageApplianceConfigurationData": { "description": "The list of storage appliance configuration data for this rack.", @@ -9984,6 +10798,7 @@ "clusterId": { "description": "The resource ID of the cluster the rack is created for. This value is set when the rack is created by the cluster.", "type": "string", + "format": "arm-id", "readOnly": true }, "detailedStatus": { @@ -10034,7 +10849,15 @@ }, "rackSkuId": { "description": "The SKU for the rack.", - "type": "string" + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/rackSkus" + } + ] + } } } }, @@ -10053,7 +10876,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "x-ms-azure-resource": true @@ -10170,6 +10993,183 @@ } } }, + "RuntimeProtectionConfiguration": { + "type": "object", + "title": "RuntimeProtectionConfiguration represents the runtime protection configuration for the cluster.", + "properties": { + "enforcementLevel": { + "description": "The mode of operation for runtime protection.", + "type": "string", + "default": "Disabled", + "enum": [ + "Audit", + "Disabled", + "OnDemand", + "Passive", + "RealTime" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "RuntimeProtectionEnforcementLevel" + } + } + } + }, + "RuntimeProtectionStatus": { + "type": "object", + "title": "RuntimeProtectionStatus represents the runtime protection status of the bare metal machine.", + "properties": { + "definitionsLastUpdated": { + "description": "The timestamp when the malware definitions were last updated.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "definitionsVersion": { + "description": "The version of the malware definitions.", + "type": "string", + "readOnly": true + }, + "scanCompletedTime": { + "description": "The timestamp of the most recently completed scan, or empty if there has never been a scan.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scanScheduledTime": { + "description": "The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scanStartedTime": { + "description": "The timestamp of the most recently started scan, or empty if there has never been a scan.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "ServiceLoadBalancerBgpPeer": { + "type": "object", + "title": "ServiceLoadBalancerBgpPeer represents the configuration of the BGP service load balancer for the Kubernetes cluster.", + "required": [ + "name", + "peerAddress", + "peerAsn" + ], + "properties": { + "bfdEnabled": { + "description": "The indicator of BFD enablement for this BgpPeer.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BfdEnabled" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "bgpMultiHop": { + "description": "The indicator to enable multi-hop peering support.", + "type": "string", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "BgpMultiHop" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "holdTime": { + "description": "The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "keepAliveTime": { + "description": "The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "myAsn": { + "description": "The autonomous system number used for the local end of the BGP session.", + "type": "integer", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "The name used to identify this BGP peer for association with a BGP advertisement.", + "type": "string", + "pattern": "^[a-z0-9]([a-z0-9.-]{0,61}[a-z0-9]){0,1}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "password": { + "description": "The authentication password for routers enforcing TCP MD5 authenticated sessions.", + "type": "string", + "maxLength": 80, + "pattern": "^[a-zA-Z0-9]{0,80}$", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "peerAddress": { + "description": "The IPv4 or IPv6 address used to connect this BGP session.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "peerAsn": { + "description": "The autonomous system number expected from the remote end of the BGP session.", + "type": "integer", + "format": "int64", + "maximum": 4294967295, + "minimum": 0, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "peerPort": { + "description": "The port used to connect this BGP session.", + "type": "integer", + "format": "int64", + "default": 179, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, "ServicePrincipalInformation": { "type": "object", "title": "ServicePrincipalInformation represents the details of the service principal to be used by the cluster during Arc Appliance installation.", @@ -10201,13 +11201,13 @@ }, "SshPublicKey": { "type": "object", - "title": "SshPublicKey represents the public key used to authenticate with the virtual machine through SSH.", + "title": "SshPublicKey represents the public key used to authenticate with a resource through SSH.", "required": [ "keyData" ], "properties": { "keyData": { - "description": "The public ssh key of the user.", + "description": "The SSH public key data.", "type": "string", "minLength": 1 } @@ -10233,31 +11233,11 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true }, - "StorageApplianceCommandSpecification": { - "type": "object", - "title": "StorageApplianceCommandSpecification represents the read-only command and optional arguments to execute against a storage appliance.", - "required": [ - "command" - ], - "properties": { - "arguments": { - "description": "The list of string arguments that will be passed to the script in order as separate arguments.", - "type": "array", - "items": { - "type": "string" - } - }, - "command": { - "description": "The read-only command to execute against the storage appliance.", - "type": "string" - } - } - }, "StorageApplianceConfigurationData": { "type": "object", "title": "StorageApplianceConfigurationData represents configuration for the storage application.", @@ -10381,6 +11361,7 @@ "clusterId": { "description": "The resource ID of the cluster this storage appliance is associated with.", "type": "string", + "format": "arm-id", "readOnly": true }, "detailedStatus": { @@ -10426,6 +11407,7 @@ "rackId": { "description": "The resource ID of the rack where this storage appliance resides.", "type": "string", + "format": "arm-id", "x-ms-mutability": [ "read", "create" @@ -10483,32 +11465,6 @@ } } }, - "StorageApplianceRunReadCommandsParameters": { - "type": "object", - "title": "StorageApplianceRunReadCommandsParameters represents the body of request containing list of read-only commands to run for a storage appliance.", - "required": [ - "commands", - "limitTimeSeconds" - ], - "properties": { - "commands": { - "description": "The list of read-only commands to run.", - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/definitions/StorageApplianceCommandSpecification" - }, - "x-ms-identifiers": [] - }, - "limitTimeSeconds": { - "description": "The maximum time the commands are allowed to run.\nIf the execution time exceeds the maximum, the script will be stopped, any output produced until then will be captured, and the exit code matching a timeout will be returned (252).", - "type": "integer", - "format": "int64", - "maximum": 14400, - "minimum": 60 - } - } - }, "StorageApplianceSkuProperties": { "type": "object", "title": "StorageApplianceSkuProperties represents the properties of the storage appliance SKU.", @@ -10543,26 +11499,6 @@ } } }, - "StorageApplianceValidateHardwareParameters": { - "type": "object", - "title": "StorageApplianceValidateHardwareParameters represents the body of the request to validate the physical hardware of a storage appliance.", - "required": [ - "validationCategory" - ], - "properties": { - "validationCategory": { - "description": "The category of hardware validation to perform.", - "type": "string", - "enum": [ - "BasicValidation" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "StorageApplianceHardwareValidationCategory" - } - } - } - }, "StorageProfile": { "type": "object", "title": "StorageProfile represents information about a disk.", @@ -10616,11 +11552,56 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true }, + "TrunkedNetworkAttachmentConfiguration": { + "type": "object", + "title": "TrunkedNetworkAttachmentConfiguration represents the configuration of the attachment of a trunked network.", + "required": [ + "networkId" + ], + "properties": { + "networkId": { + "description": "The resource ID of the network that is being configured for attachment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetworkCloud/trunkedNetworks" + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "pluginType": { + "description": "The indicator of how this network will be utilized by the Kubernetes cluster.", + "type": "string", + "default": "SRIOV", + "enum": [ + "DPDK", + "SRIOV", + "OSDevice", + "MACVLAN", + "IPVLAN" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "KubernetesPluginType" + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, "TrunkedNetworkList": { "type": "object", "title": "TrunkedNetworkList represents a list of trunked networks.", @@ -10659,9 +11640,18 @@ "vlans" ], "properties": { + "associatedResourceIds": { + "description": "The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, "clusterId": { "description": "The resource ID of the Network Cloud cluster this trunked network is associated with.", "type": "string", + "format": "arm-id", "readOnly": true }, "detailedStatus": { @@ -10684,7 +11674,7 @@ "readOnly": true }, "hybridAksClustersAssociatedIds": { - "description": "The list of Hybrid AKS cluster resource IDs that are associated with this trunked network.", + "description": "Field Deprecated. These fields will be empty/omitted. The list of Hybrid AKS cluster resource IDs that are associated with this trunked network.", "type": "array", "items": { "type": "string" @@ -10692,7 +11682,7 @@ "readOnly": true }, "hybridAksPluginType": { - "description": "The network plugin type for Hybrid AKS.", + "description": "Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The network plugin type for Hybrid AKS.", "type": "string", "default": "SRIOV", "enum": [ @@ -10748,7 +11738,7 @@ "readOnly": true }, "virtualMachinesAssociatedIds": { - "description": "The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this trunked network.", + "description": "Field Deprecated. These fields will be empty/omitted. The list of virtual machine resource IDs, excluding any Hybrid AKS virtual machines, that are currently using this trunked network.", "type": "array", "items": { "type": "string" @@ -10831,7 +11821,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -10910,7 +11900,7 @@ "resourceId": { "description": "The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine.", "type": "string", - "minLength": 1, + "format": "arm-id", "x-ms-mutability": [ "read", "create" @@ -10992,9 +11982,15 @@ "create" ] }, + "availabilityZone": { + "description": "The cluster availability zone containing this virtual machine.", + "type": "string", + "readOnly": true + }, "bareMetalMachineId": { - "description": "The resource ID of the bare metal machine the virtual machine has landed to.", + "description": "The resource ID of the bare metal machine that hosts the virtual machine.", "type": "string", + "format": "arm-id", "readOnly": true }, "bootMethod": { @@ -11025,6 +12021,7 @@ "clusterId": { "description": "The resource ID of the cluster the virtual machine is created for.", "type": "string", + "format": "arm-id", "readOnly": true }, "cpuCores": { @@ -11041,9 +12038,14 @@ "description": "The more detailed status of the virtual machine.", "type": "string", "enum": [ - "Error", "Available", - "Provisioning" + "Error", + "Provisioning", + "Running", + "Scheduling", + "Stopped", + "Terminating", + "Unknown" ], "x-ms-enum": { "modelAsString": true, @@ -11120,7 +12122,8 @@ "type": "string", "enum": [ "On", - "Off" + "Off", + "Unknown" ], "x-ms-enum": { "modelAsString": true, @@ -11228,19 +12231,6 @@ } } }, - "VirtualMachineVolumeParameters": { - "type": "object", - "title": "VirtualMachineVolumeParameters represents the body of the request to handle attachment and detachment of volumes for the virtual machine.", - "required": [ - "volumeId" - ], - "properties": { - "volumeId": { - "description": "The resource ID of the volume.", - "type": "string" - } - } - }, "Volume": { "type": "object", "title": "Volume represents storage made available for use by resources running on the cluster.", @@ -11261,7 +12251,7 @@ }, "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "x-ms-azure-resource": true @@ -11365,7 +12355,16 @@ } }, "parameters": { - "BareMetalMachineKeySetName": { + "AgentPoolNameParameter": { + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the Kubernetes cluster agent pool.", + "name": "agentPoolName", + "in": "path", + "required": true + }, + "BareMetalMachineKeySetNameParameter": { "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", "type": "string", "x-ms-parameter-location": "method", @@ -11383,7 +12382,7 @@ "in": "path", "required": true }, - "BmcKeySetName": { + "BmcKeySetNameParameter": { "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", "type": "string", "x-ms-parameter-location": "method", @@ -11428,21 +12427,12 @@ "in": "path", "required": true }, - "DefaultCniNetworkNameParameter": { + "KubernetesClusterNameParameter": { "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$", "type": "string", "x-ms-parameter-location": "method", - "description": "The name of the default CNI network.", - "name": "defaultCniNetworkName", - "in": "path", - "required": true - }, - "HybridAksClusterNameParameter": { - "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9])$", - "type": "string", - "x-ms-parameter-location": "method", - "description": "The name of the Hybrid AKS cluster.", - "name": "hybridAksClusterName", + "description": "The name of the Kubernetes cluster.", + "name": "kubernetesClusterName", "in": "path", "required": true }, @@ -11518,7 +12508,7 @@ "required": true }, "VolumeNameParameter": { - "pattern": "^([a-zA-Z0-9][a-zA-Z0-9]{0,28}[a-zA-Z0-9])$", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-_]{0,62}[a-zA-Z0-9])$", "type": "string", "x-ms-parameter-location": "method", "description": "The name of the volume.", diff --git a/specification/networkcloud/resource-manager/readme.md b/specification/networkcloud/resource-manager/readme.md index fe14d6e20930..ac23ad010f49 100644 --- a/specification/networkcloud/resource-manager/readme.md +++ b/specification/networkcloud/resource-manager/readme.md @@ -27,18 +27,7 @@ These are the global settings for NetworkCloud. ```yaml openapi-type: arm openapi-subtype: providerHub -tag: package-2023-07-01 -``` - ---- - -### Tag: package-2022-12-12-preview - -These settings apply only when `--tag=package-2022-12-12-preview` is specified on the command line. - -```yaml $(tag) == 'package-2022-12-12-preview' -input-file: - - Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json +tag: package-2023-10-01-preview ``` --- @@ -61,6 +50,15 @@ input-file: - Microsoft.NetworkCloud/stable/2023-07-01/networkcloud.json ``` +### Tag: package-2023-10-01-preview + +These settings apply only when `--tag=package-2023-10-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-10-01-preview' +input-file: + - Microsoft.NetworkCloud/preview/2023-10-01-preview/networkcloud.json +``` + --- # Code Generation diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json new file mode 100644 index 000000000000..cd20659352df --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json @@ -0,0 +1,3424 @@ +{ + "swagger": "2.0", + "info": { + "title": "NewRelic.Observability", + "version": "2023-11-01-preview", + "x-cadl-generated": [ + { + "emitter": "@azure-tools/cadl-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Microsoft Entra ID OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Monitors" + }, + { + "name": "Accounts" + }, + { + "name": "Organizations" + }, + { + "name": "Plan" + }, + { + "name": "TagRules" + } + ], + "paths": { + "/providers/NewRelic.Observability/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet_Gen": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_List", + "description": "List all the existing accounts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/UserEmailParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccountsListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Accounts_List_MaximumSet_Gen": { + "$ref": "./examples/Accounts_List_MaximumSet_Gen.json" + }, + "Accounts_List_MinimumSet_Gen": { + "$ref": "./examples/Accounts_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/monitors": { + "get": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListBySubscription", + "description": "List NewRelicMonitorResource resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/organizations": { + "get": { + "tags": [ + "Organizations" + ], + "operationId": "Organizations_List", + "description": "List all the existing organizations", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/UserEmailParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationsListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Organizations_List_MaximumSet_Gen": { + "$ref": "./examples/Organizations_List_MaximumSet_Gen.json" + }, + "Organizations_List_MinimumSet_Gen": { + "$ref": "./examples/Organizations_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/plans": { + "get": { + "tags": [ + "Plan" + ], + "operationId": "Plans_List", + "description": "List plans data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccountIdParameter" + }, + { + "$ref": "#/parameters/OrganizationIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PlanDataListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Plans_List_MaximumSet_Gen": { + "$ref": "./examples/Plans_List_MaximumSet_Gen.json" + }, + "Plans_List_MinimumSet_Gen": { + "$ref": "./examples/Plans_List_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors": { + "get": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListByResourceGroup", + "description": "List NewRelicMonitorResource resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}": { + "get": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_Get", + "description": "Get a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_CreateOrUpdate", + "description": "Create a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "headers": { + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + } + }, + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_Update", + "description": "Update a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Update_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_Delete", + "description": "Delete a NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/UserEmailParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Delete_MaximumSet_Gen": { + "$ref": "./examples/Monitors_Delete_MaximumSet_Gen.json" + }, + "Monitors_Delete_MinimumSet_Gen": { + "$ref": "./examples/Monitors_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getMetricRules": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_GetMetricRules", + "description": "Get metric rules", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/MetricsRequestParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MetricRules" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMetricRules_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricRules_MaximumSet_Gen.json" + }, + "Monitors_GetMetricRules_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricRules_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getMetricStatus": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_GetMetricStatus", + "description": "Get metric status", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/MetricsStatusRequestParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MetricsStatusResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMetricStatus_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricStatus_MaximumSet_Gen.json" + }, + "Monitors_GetMetricStatus_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricStatus_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listAppServices": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListAppServices", + "description": "List the app service resources currently being monitored by the NewRelic resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/AppServicesGetParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppServicesListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListAppServices_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListAppServices_MaximumSet_Gen.json" + }, + "Monitors_ListAppServices_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListAppServices_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/switchBilling": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_SwitchBilling", + "description": "Switches the billing for NewRelic monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/SwitchBillingParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_SwitchBilling_MaximumSet_Gen": { + "$ref": "./examples/Monitors_SwitchBilling_MaximumSet_Gen.json" + }, + "Monitors_SwitchBilling_MinimumSet_Gen": { + "$ref": "./examples/Monitors_SwitchBilling_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listHosts": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListHosts", + "description": "List the compute vm resources currently being monitored by the NewRelic resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "#/parameters/HostsGetParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VMHostsListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListHosts_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListHosts_MaximumSet_Gen.json" + }, + "Monitors_ListHosts_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListHosts_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredResources": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_ListMonitoredResources", + "description": "List the resources currently being monitored by the NewRelic monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListMonitoredResources_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json" + }, + "Monitors_ListMonitoredResources_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getBillingInfo": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "Get marketplace info mapped to the given monitor.", + "operationId": "BillingInfo_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listConnectedPartnerResources": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "List of all active deployments that are associated with the marketplace subscription linked to the given monitor.", + "operationId": "ConnectedPartnerResources_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Email Id of the user", + "schema": { + "$ref": "#/definitions/email" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ConnectedPartnerResourcesListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConnectedPartnerResources_List": { + "$ref": "./examples/ConnectedPartnerResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/tagRules": { + "get": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_ListByNewRelicMonitorResource", + "description": "List TagRule resources by NewRelicMonitorResource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen": { + "$ref": "./examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json" + }, + "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen": { + "$ref": "./examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/tagRules/{ruleSetName}": { + "get": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_Get", + "description": "Get a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Get_MaximumSet_Gen.json" + }, + "TagRules_Get_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Get_MinimumSet_Gen.json" + } + } + }, + "put": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_CreateOrUpdate", + "description": "Create a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/TagRule" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "headers": { + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + } + }, + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json" + }, + "TagRules_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_Delete", + "description": "Delete a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Delete_MaximumSet_Gen.json" + }, + "TagRules_Delete_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Delete_MinimumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "TagRules" + ], + "operationId": "TagRules_Update", + "description": "Update a TagRule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "required": true, + "description": "Name of the TagRule", + "type": "string" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/TagRuleUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Update_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Update_MaximumSet_Gen.json" + }, + "TagRules_Update_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Update_MinimumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the NewRelic monitor resource.", + "operationId": "MonitoredSubscriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "pattern": "^.*$", + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionPropertiesList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the NewRelic monitor resource.", + "operationId": "MonitoredSubscriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "pattern": "^.*$", + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "Add the subscriptions that should be monitored by the NewRelic monitor resource.", + "operationId": "MonitoredSubscriptions_CreateorUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_AddMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_CreateorUpdate.json" + } + } + }, + "patch": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the NewRelic monitor resource", + "operationId": "MonitoredSubscriptions_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_UpdateMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the NewRelic monitor resource", + "operationId": "MonitoredSubscriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "pattern": "^.*$", + "type": "string" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_DeleteMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listLinkedResources": { + "post": { + "tags": [ + "LinkedResources" + ], + "summary": "List all Azure resources associated to the same NewRelic organization and account as the target resource.", + "operationId": "Monitors_ListLinkedResources", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "pattern": "^.*$", + "description": "Name of the Monitors resource", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LinkedResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListLinkedResources": { + "$ref": "./examples/LinkedResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/vmHostPayloads": { + "post": { + "tags": [ + "Monitors" + ], + "operationId": "Monitors_VmHostPayload", + "description": "Returns the payload that needs to be passed in the request body for installing NewRelic agent on a VM.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "required": true, + "description": "Name of the Monitors resource", + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VMExtensionPayload" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_VmHostPayload_MaximumSet_Gen": { + "$ref": "./examples/Monitors_VmHostPayload_MaximumSet_Gen.json" + }, + "Monitors_VmHostPayload_MinimumSet_Gen": { + "$ref": "./examples/Monitors_VmHostPayload_MinimumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AccountCreationSource": { + "type": "string", + "description": "Source of Account creation", + "enum": [ + "LIFTR", + "NEWRELIC" + ], + "x-ms-enum": { + "name": "AccountCreationSource", + "modelAsString": true, + "values": [ + { + "name": "LIFTR", + "value": "LIFTR", + "description": "Account is created from LIFTR" + }, + { + "name": "NEWRELIC", + "value": "NEWRELIC", + "description": "Account is created from NEWRELIC" + } + ] + } + }, + "AccountIdParameter": { + "type": "object", + "properties": {}, + "description": "Account Id parameter" + }, + "AccountInfo": { + "type": "object", + "properties": { + "accountId": { + "type": "string", + "description": "Account id" + }, + "ingestionKey": { + "$ref": "#/definitions/SecureString", + "description": "ingestion key of account" + }, + "region": { + "type": "string", + "description": "Region where New Relic account is present" + } + }, + "description": "Account Info of the NewRelic account" + }, + "AccountProperties": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "organization id" + }, + "accountId": { + "type": "string", + "description": "account id" + }, + "accountName": { + "type": "string", + "description": "account name" + }, + "region": { + "type": "string", + "description": "Region where New Relic account is present" + } + }, + "description": "List of all the New relic accounts for the given user" + }, + "AccountsListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountResource" + }, + "x-cadl-name": "AccountResource[]", + "description": "The AccountResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of get all accounts Operation.", + "required": [ + "value" + ] + }, + "BillingInfoResponse": { + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "type": "object", + "properties": { + "marketplaceSaasInfo": { + "description": "Marketplace Subscription details", + "$ref": "#/definitions/MarketplaceSaaSInfo" + }, + "partnerBillingEntity": { + "description": "Partner Billing Entity details: Organization Info", + "$ref": "#/definitions/PartnerBillingEntity" + } + } + }, + "MarketplaceSaaSInfo": { + "description": "Marketplace SAAS Info of the resource.", + "type": "object", + "properties": { + "marketplaceSubscriptionId": { + "description": "Marketplace Subscription Id. This is a GUID-formatted string.", + "type": "string" + }, + "marketplaceSubscriptionName": { + "description": "Marketplace Subscription Details: SAAS Name", + "type": "string" + }, + "marketplaceResourceId": { + "description": "Marketplace Subscription Details: Resource URI", + "type": "string" + }, + "marketplaceStatus": { + "description": "Marketplace Subscription Details: SaaS Subscription Status", + "type": "string" + }, + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", + "type": "string" + } + } + }, + "PartnerBillingEntity": { + "description": "Partner Billing details associated with the resource.", + "type": "object", + "properties": { + "organizationId": { + "description": "The New Relic Organization Id.", + "type": "string" + }, + "organizationName": { + "description": "The New Relic Organization Name.", + "type": "string" + } + } + }, + "ConnectedPartnerResourceProperties": { + "description": "Connected Partner Resource Properties", + "type": "object", + "properties": { + "accountName": { + "description": "NewRelic account name", + "type": "string" + }, + "accountId": { + "description": "NewRelic Account Id", + "type": "string" + }, + "azureResourceId": { + "description": "The azure resource Id of the deployment.", + "type": "string" + }, + "location": { + "description": "The location of the deployment.", + "type": "string" + } + } + }, + "ConnectedPartnerResourcesListFormat": { + "description": "Connected Partner Resources List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedPartnerResourceProperties" + } + } + }, + "ConnectedPartnerResourcesListResponse": { + "description": " List of all active newrelic deployments.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedPartnerResourcesListFormat" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "AccountResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "The details of a account resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "AppServiceInfo": { + "type": "object", + "properties": { + "azureResourceId": { + "type": "string", + "description": "Azure App service resource ID" + }, + "agentVersion": { + "type": "string", + "description": "Version of the NewRelic agent installed on the App service." + }, + "agentStatus": { + "type": "string", + "description": "Status of the NewRelic agent installed on the App service." + } + }, + "description": "Details of VM Resource having NewRelic OneAgent installed" + }, + "AppServicesGetParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/AppServicesGetRequest", + "description": "The details of the app services get request." + } + }, + "description": "App services Get Parameter specification.", + "required": [ + "request" + ] + }, + "SwitchBillingParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/SwitchBillingRequest", + "description": "The details of the switch billing request." + } + }, + "description": "Switch Billing Parameter specification.", + "required": [ + "request" + ] + }, + "SwitchBillingRequest": { + "type": "object", + "properties": { + "azureResourceId": { + "type": "string", + "description": "Azure resource Id" + }, + "organizationId": { + "type": "string", + "description": "Organization id" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of a switch billing Operation.", + "required": [ + "userEmail" + ] + }, + "AppServicesGetRequest": { + "type": "object", + "properties": { + "azureResourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Azure resource IDs" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of a app services get Operation.", + "required": [ + "userEmail" + ] + }, + "AppServicesListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AppServiceInfo" + }, + "x-ms-identifiers": [ + "azureResourceId" + ], + "x-cadl-name": "AppServiceInfo[]", + "description": "The AppServiceInfo items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of a list app services Operation.", + "required": [ + "value" + ] + }, + "BillingCycle": { + "type": "string", + "description": "Different usage type like YEARLY/MONTHLY", + "enum": [ + "YEARLY", + "MONTHLY", + "WEEKLY" + ], + "x-ms-enum": { + "name": "BillingCycle", + "modelAsString": true, + "values": [ + { + "name": "YEARLY", + "value": "YEARLY", + "description": "Billing cycle is YEARLY" + }, + { + "name": "MONTHLY", + "value": "MONTHLY", + "description": "Billing cycle is MONTHLY" + }, + { + "name": "WEEKLY", + "value": "WEEKLY", + "description": "Billing cycle is WEEKLY" + } + ] + } + }, + "BillingSource": { + "type": "string", + "description": "Billing source", + "enum": [ + "AZURE", + "NEWRELIC" + ], + "x-ms-enum": { + "name": "BillingSource", + "modelAsString": true, + "values": [ + { + "name": "AZURE", + "value": "AZURE", + "description": "Billing source is Azure" + }, + { + "name": "NEWRELIC", + "value": "NEWRELIC" + } + ] + } + }, + "FilteringTag": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name (also known as the key) of the tag." + }, + "value": { + "type": "string", + "description": "The value of the tag." + }, + "action": { + "$ref": "#/definitions/TagAction", + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion." + } + }, + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored." + }, + "HostsGetParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/HostsGetRequest", + "description": "The details of the Hosts get request." + } + }, + "description": "Host Get Parameter specification.", + "required": [ + "request" + ] + }, + "HostsGetRequest": { + "type": "object", + "properties": { + "vmIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "VM resource IDs" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of a Hosts get Operation.", + "required": [ + "userEmail" + ] + }, + "LiftrResourceCategories": { + "type": "string", + "description": "Liftr Resource category.", + "enum": [ + "Unknown", + "MonitorLogs" + ], + "x-ms-enum": { + "name": "LiftrResourceCategories", + "modelAsString": true + } + }, + "LocationParameter": { + "type": "object", + "properties": {}, + "description": "Location for NewRelic resource" + }, + "LogRules": { + "type": "object", + "properties": { + "sendAadLogs": { + "$ref": "#/definitions/SendAadLogsStatus", + "description": "Flag specifying if AAD logs should be sent for the Monitor resource." + }, + "sendSubscriptionLogs": { + "$ref": "#/definitions/SendSubscriptionLogsStatus", + "description": "Flag specifying if subscription logs should be sent for the Monitor resource." + }, + "sendActivityLogs": { + "$ref": "#/definitions/SendActivityLogsStatus", + "description": "Flag specifying if activity logs from Azure resources should be sent for the Monitor resource." + }, + "filteringTags": { + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + }, + "x-ms-identifiers": [], + "x-cadl-name": "FilteringTag[]", + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured.\nIf only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags." + } + }, + "description": "Set of rules for sending logs for the Monitor resource." + }, + "MarketplaceSubscriptionStatus": { + "type": "string", + "description": "Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.", + "enum": [ + "Active", + "Suspended" + ], + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "monitoring is enabled" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "monitoring is disabled" + } + ] + } + }, + "MetricRules": { + "type": "object", + "properties": { + "sendMetrics": { + "$ref": "#/definitions/SendMetricsStatus", + "description": "Flag specifying if metrics should be sent for the Monitor resource." + }, + "filteringTags": { + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + }, + "x-ms-identifiers": [], + "x-cadl-name": "FilteringTag[]", + "description": "List of filtering tags to be used for capturing metrics." + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Set of rules for sending metrics for the Monitor resource." + }, + "MetricsRequest": { + "type": "object", + "properties": { + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of get metrics Operation.", + "required": [ + "userEmail" + ] + }, + "MetricsRequestParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/MetricsRequest", + "description": "The details of the get metrics status request." + } + }, + "description": "Get Metrics Status Parameter specification.", + "required": [ + "request" + ] + }, + "MetricsStatusRequest": { + "type": "object", + "properties": { + "azureResourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Azure resource IDs" + }, + "userEmail": { + "$ref": "#/definitions/email", + "description": "User Email" + } + }, + "description": "Request of get metrics status Operation.", + "required": [ + "userEmail" + ] + }, + "MetricsStatusRequestParameter": { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/MetricsStatusRequest", + "description": "The details of the get metrics status request." + } + }, + "description": "Get Metrics Status Parameter specification.", + "required": [ + "request" + ] + }, + "MetricsStatusResponse": { + "type": "object", + "properties": { + "azureResourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-cadl-name": "string[]", + "description": "Azure resource IDs" + } + }, + "description": "Response of get metrics status Operation." + }, + "MonitorProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + }, + "monitoringStatus": { + "$ref": "#/definitions/MonitoringStatus", + "description": "MonitoringStatus of the resource", + "readOnly": true + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "description": "NewRelic Organization properties of the resource", + "readOnly": true + }, + "marketplaceSubscriptionId": { + "type": "string", + "description": "Marketplace Subscription Id", + "readOnly": true + }, + "newRelicAccountProperties": { + "$ref": "#/definitions/NewRelicAccountProperties", + "description": "MarketplaceSubscriptionStatus of the resource" + }, + "userInfo": { + "$ref": "#/definitions/UserInfo", + "description": "User Info" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories", + "description": "Liftr resource category", + "readOnly": true + }, + "liftrResourcePreference": { + "type": "integer", + "format": "int32", + "description": "Liftr resource preference. The priority of the resource.", + "readOnly": true + }, + "orgCreationSource": { + "$ref": "#/definitions/OrgCreationSource", + "description": "Source of org creation" + }, + "accountCreationSource": { + "$ref": "#/definitions/AccountCreationSource", + "description": "Source of account creation" + } + }, + "description": "Properties specific to the NewRelic Monitor resource" + }, + "MonitoredResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM id of the resource." + }, + "sendingMetrics": { + "$ref": "#/definitions/SendingMetricsStatus", + "description": "Flag indicating if resource is sending metrics to NewRelic." + }, + "reasonForMetricsStatus": { + "type": "string", + "description": "Reason for why the resource is sending metrics (or why it is not sending)." + }, + "sendingLogs": { + "$ref": "#/definitions/SendingLogsStatus", + "description": "Flag indicating if resource is sending logs to NewRelic." + }, + "reasonForLogsStatus": { + "type": "string", + "description": "Reason for why the resource is sending logs (or why it is not sending)." + } + }, + "description": "Details of resource being monitored by NewRelic monitor resource" + }, + "MonitoredResourceListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredResource" + }, + "x-cadl-name": "MonitoredResource[]", + "description": "The MonitoredResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "List of all the resources being monitored by NewRelic monitor resource", + "required": [ + "value" + ] + }, + "MonitoringStatus": { + "type": "string", + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "monitoring is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "monitoring is disabled" + } + ] + } + }, + "MonitoringTagRulesProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + }, + "logRules": { + "$ref": "#/definitions/LogRules", + "description": "Set of rules for sending logs for the Monitor resource." + }, + "metricRules": { + "$ref": "#/definitions/MetricRules", + "description": "Set of rules for sending metrics for the Monitor resource." + } + }, + "description": "The resource-specific properties for this resource." + }, + "NewRelicAccountProperties": { + "type": "object", + "properties": { + "userId": { + "type": "string", + "description": "User id" + }, + "accountInfo": { + "$ref": "#/definitions/AccountInfo", + "description": "NewRelic Account Information" + }, + "organizationInfo": { + "$ref": "#/definitions/OrganizationInfo", + "description": "NewRelic Organization Information" + }, + "singleSignOnProperties": { + "$ref": "#/definitions/NewRelicSingleSignOnProperties", + "description": "date when plan was applied" + } + }, + "description": "Properties of the NewRelic account" + }, + "NewRelicMonitorResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MonitorProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "A Monitor Resource by NewRelic", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "NewRelicMonitorResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NewRelicMonitorResource" + }, + "x-cadl-name": "NewRelicMonitorResource[]", + "description": "The NewRelicMonitorResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "The response of a NewRelicMonitorResource list operation.", + "required": [ + "value" + ] + }, + "NewRelicMonitorResourceUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-cadl-name": "Record", + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/NewRelicMonitorResourceUpdateProperties", + "x-ms-client-flatten": true + } + }, + "description": "The type used for update operations of the NewRelicMonitorResource." + }, + "NewRelicMonitorResourceUpdateProperties": { + "type": "object", + "properties": { + "newRelicAccountProperties": { + "$ref": "#/definitions/NewRelicAccountProperties", + "description": "MarketplaceSubscriptionStatus of the resource" + }, + "userInfo": { + "$ref": "#/definitions/UserInfo", + "description": "User Info" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "orgCreationSource": { + "$ref": "#/definitions/OrgCreationSource", + "description": "Source of org creation" + }, + "accountCreationSource": { + "$ref": "#/definitions/AccountCreationSource", + "description": "Source of account creation" + } + }, + "description": "The updatable properties of the NewRelicMonitorResource." + }, + "NewRelicSingleSignOnProperties": { + "type": "object", + "properties": { + "singleSignOnState": { + "$ref": "#/definitions/SingleSignOnStates", + "description": "Single sign-on state" + }, + "enterpriseAppId": { + "type": "string", + "description": "The Id of the Enterprise App used for Single sign-on." + }, + "singleSignOnUrl": { + "type": "string", + "description": "The login URL specific to this NewRelic Organization" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state" + } + }, + "description": "Single sign on Info of the NewRelic account" + }, + "OrgCreationSource": { + "type": "string", + "description": "Source of Org creation", + "enum": [ + "LIFTR", + "NEWRELIC" + ], + "x-ms-enum": { + "name": "OrgCreationSource", + "modelAsString": true, + "values": [ + { + "name": "LIFTR", + "value": "LIFTR", + "description": "Org is created from LIFTR" + }, + { + "name": "NEWRELIC", + "value": "NEWRELIC", + "description": "Org is created from NEWRELIC" + } + ] + } + }, + "OrganizationIdParameter": { + "type": "object", + "properties": {}, + "description": "Organization Id parameter" + }, + "OrganizationInfo": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Organization id" + } + }, + "description": "Organization Info of the NewRelic account" + }, + "OrganizationProperties": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "organization id" + }, + "organizationName": { + "type": "string", + "description": "organization name" + }, + "billingSource": { + "$ref": "#/definitions/BillingSource", + "description": "Billing source" + } + }, + "description": "Details of Organizations" + }, + "OrganizationsListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OrganizationResource" + }, + "x-cadl-name": "OrganizationResource[]", + "description": "The OrganizationResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of get all organizations Operation.", + "required": [ + "value" + ] + }, + "OrganizationResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OrganizationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "The details of a Organization resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PlanData": { + "type": "object", + "properties": { + "usageType": { + "$ref": "#/definitions/UsageType", + "description": "Different usage type like PAYG/COMMITTED. this could be enum" + }, + "billingCycle": { + "$ref": "#/definitions/BillingCycle", + "description": "Different billing cycles like MONTHLY/WEEKLY. this could be enum" + }, + "planDetails": { + "type": "string", + "description": "plan id as published by NewRelic" + }, + "effectiveDate": { + "type": "string", + "format": "date-time", + "description": "date when plan was applied" + } + }, + "description": "Plan data of NewRelic Monitor resource" + }, + "PlanDataResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PlanDataProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "The details of a PlanData resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PlanDataListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PlanDataResource" + }, + "x-cadl-name": "PlanDataResource[]", + "description": "The PlanDataResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of get all plan data Operation.", + "required": [ + "value" + ] + }, + "PlanDataProperties": { + "type": "object", + "properties": { + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "orgCreationSource": { + "$ref": "#/definitions/OrgCreationSource", + "description": "Source of org creation" + }, + "accountCreationSource": { + "$ref": "#/definitions/AccountCreationSource", + "description": "Source of account creation" + } + }, + "description": "Plan details" + }, + "MonitoredSubscription": { + "description": "The list of subscriptions and it's monitoring status by current NewRelic monitor.", + "type": "object", + "properties": { + "subscriptionId": { + "description": "The subscriptionId to be monitored.", + "required": [ + "subscriptionId" + ], + "type": "string" + }, + "status": { + "description": "The state of monitoring.", + "enum": [ + "InProgress", + "Active", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "Status" + }, + "type": "string" + }, + "error": { + "description": "The reason of not monitoring the subscription.", + "type": "string" + }, + "tagRules": { + "$ref": "#/definitions/MonitoringTagRulesProperties" + } + } + }, + "SubscriptionList": { + "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource.", + "type": "object", + "properties": { + "patchOperation": { + "description": "The operation for the patch on the resource.", + "enum": [ + "AddBegin", + "AddComplete", + "DeleteBegin", + "DeleteComplete", + "Active" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "PatchOperation" + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "monitoredSubscriptionList": { + "description": "List of subscriptions and the state of the monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscription" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + } + } + }, + "MonitoredSubscriptionProperties": { + "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SubscriptionList" + } + } + }, + "MonitoredSubscriptionPropertiesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + } + }, + "LinkedResource": { + "description": "The definition of a linked resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the linked resource.", + "type": "string" + } + } + }, + "LinkedResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkedResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning State of the Monitor resource", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted", + "description": "Monitor resource creation request accepted" + }, + { + "name": "Creating", + "value": "Creating", + "description": "Monitor resource creation started" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Monitor resource is being updated" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Monitor resource deletion started" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Monitor resource creation successful" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Monitor resource creation failed" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Monitor resource creation canceled" + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Monitor resource is deleted" + }, + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "Monitor resource state is unknown" + } + ] + } + }, + "SecureString": { + "type": "string", + "description": "Credential string.", + "format": "password", + "x-ms-secret": true + }, + "SendAadLogsStatus": { + "type": "string", + "description": "Indicates whether AAD logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendAadLogsStatus", + "modelAsString": true + } + }, + "SendActivityLogsStatus": { + "type": "string", + "description": "Indicates whether activity logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendActivityLogsStatus", + "modelAsString": true + } + }, + "SendMetricsStatus": { + "type": "string", + "description": "Indicates whether metrics are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendMetricsStatus", + "modelAsString": true + } + }, + "SendSubscriptionLogsStatus": { + "type": "string", + "description": "Indicates whether subscription logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendSubscriptionLogsStatus", + "modelAsString": true + } + }, + "SendingLogsStatus": { + "type": "string", + "description": "Indicates whether logs are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendingLogsStatus", + "modelAsString": true + } + }, + "SendingMetricsStatus": { + "type": "string", + "description": "Indicates whether metrics are being sent.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SendingMetricsStatus", + "modelAsString": true + } + }, + "SingleSignOnStates": { + "type": "string", + "description": "Various states of the SSO resource", + "enum": [ + "Initial", + "Enable", + "Disable", + "Existing" + ], + "x-ms-enum": { + "name": "SingleSignOnStates", + "modelAsString": true + } + }, + "TagAction": { + "type": "string", + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "x-ms-enum": { + "name": "TagAction", + "modelAsString": true + } + }, + "TagRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MonitoringTagRulesProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "A tag rule belonging to NewRelic account", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "TagRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagRule" + }, + "x-cadl-name": "TagRule[]", + "description": "The TagRule items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "The response of a TagRule list operation.", + "required": [ + "value" + ] + }, + "TagRuleUpdate": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TagRuleUpdateProperties", + "x-ms-client-flatten": true + } + }, + "description": "The type used for update operations of the TagRule." + }, + "TagRuleUpdateProperties": { + "type": "object", + "properties": { + "logRules": { + "$ref": "#/definitions/LogRules", + "description": "Set of rules for sending logs for the Monitor resource." + }, + "metricRules": { + "$ref": "#/definitions/MetricRules", + "description": "Set of rules for sending metrics for the Monitor resource." + } + }, + "description": "The updatable properties of the TagRule." + }, + "UsageType": { + "type": "string", + "description": "Different usage type like PAYG/COMMITTED", + "enum": [ + "PAYG", + "COMMITTED" + ], + "x-ms-enum": { + "name": "UsageType", + "modelAsString": true, + "values": [ + { + "name": "PAYG", + "value": "PAYG", + "description": "Usage type is PAYG" + }, + { + "name": "COMMITTED", + "value": "COMMITTED", + "description": "Usage type is COMMITTED" + } + ] + } + }, + "UserEmailParameter": { + "type": "object", + "properties": {}, + "description": "User email specification." + }, + "UserInfo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "description": "First name", + "maxLength": 50 + }, + "lastName": { + "type": "string", + "description": "Last name", + "maxLength": 50 + }, + "emailAddress": { + "$ref": "#/definitions/email", + "description": "User Email" + }, + "phoneNumber": { + "type": "string", + "description": "Contact phone number", + "maxLength": 40 + }, + "country": { + "type": "string", + "description": "country if user" + } + }, + "description": "User Info of NewRelic Monitor resource" + }, + "VMExtensionPayload": { + "type": "object", + "properties": { + "ingestionKey": { + "type": "string", + "description": "Ingestion key of the account" + } + }, + "description": "Response of payload to be passed while installing VM agent." + }, + "VMHostsListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VMInfo" + }, + "x-ms-identifiers": [], + "x-cadl-name": "VMInfo[]", + "description": "The VMInfo items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-cadl-name": "Rest.ResourceLocation" + } + }, + "description": "Response of a list VM Host Operation.", + "required": [ + "value" + ] + }, + "VMInfo": { + "type": "object", + "properties": { + "vmId": { + "type": "string", + "description": "Azure VM resource ID" + }, + "agentVersion": { + "type": "string", + "description": "Version of the NewRelic agent installed on the VM." + }, + "agentStatus": { + "type": "string", + "description": "Status of the NewRelic agent installed on the VM." + } + }, + "description": "Details of VM Resource having NewRelic OneAgent installed" + }, + "email": { + "type": "string", + "description": "Reusable representation of an email address", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" + } + }, + "parameters": { + "AccountIdParameter": { + "name": "accountId", + "in": "query", + "required": false, + "description": "Account Id.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "AppServicesGetParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the app services get request.", + "schema": { + "$ref": "#/definitions/AppServicesGetRequest" + }, + "x-ms-parameter-location": "method" + }, + "SwitchBillingParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the switch billing request.", + "schema": { + "$ref": "#/definitions/SwitchBillingRequest" + }, + "x-ms-parameter-location": "method" + }, + "HostsGetParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the Hosts get request.", + "schema": { + "$ref": "#/definitions/HostsGetRequest" + }, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "query", + "required": true, + "description": "Location for NewRelic.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "MetricsRequestParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the get metrics status request.", + "schema": { + "$ref": "#/definitions/MetricsRequest" + }, + "x-ms-parameter-location": "method" + }, + "MetricsStatusRequestParameter": { + "name": "request", + "in": "body", + "required": true, + "description": "The details of the get metrics status request.", + "schema": { + "$ref": "#/definitions/MetricsStatusRequest" + }, + "x-ms-parameter-location": "method" + }, + "OrganizationIdParameter": { + "name": "organizationId", + "in": "query", + "required": false, + "description": "Organization Id.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "UserEmailParameter": { + "name": "userEmail", + "in": "query", + "required": true, + "description": "User Email.", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Accounts_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Accounts_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..cb85d5ce72db --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Accounts_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Accounts_List", + "title": "Accounts_List_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "organizationId": "wvdclwi", + "accountId": "igmdjq", + "accountName": "accname", + "region": "xnsylopqwcggudcln" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Accounts_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Accounts_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..57a7915d3cc3 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Accounts_List_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "operationId": "Accounts_List", + "title": "Accounts_List_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/BillingInfo_Get.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..0ac9f0b8b58e --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/BillingInfo_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "marketplaceSubscriptionId": "12345678-1234-1234-1234-123456789012", + "marketplaceSubscriptionName": "AzNewRelic_b1190c8f", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzNewRelic_b1190c8f", + "marketplaceStatus": "Active", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "partnerBillingEntity": { + "organizationId": "1234567890", + "organizationName": "NROrganizationName" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/ConnectedPartnerResources_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/ConnectedPartnerResources_List.json new file mode 100644 index 000000000000..eb37a722d71a --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/ConnectedPartnerResources_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "accountName": "accountName", + "accountId": "1156243", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "location": "West US 2" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/LinkedResources_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/LinkedResources_List.json new file mode 100644 index 000000000000..c9a8cd712c53 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/LinkedResources_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json new file mode 100644 index 000000000000..5e809fecb9b8 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "requestBody": { + "properties": { + "operation": "AddBegin", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_Delete.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_Delete.json new file mode 100644 index 000000000000..65005dfb9cb0 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/NewRelic.Observability/monitors/test?api-version=2022-09-01" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_Get.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_Get.json new file mode 100644 index 000000000000..a4b53cc05107 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_Get.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_List.json new file mode 100644 index 000000000000..1b78db492649 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_List.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_Update.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_Update.json new file mode 100644 index 000000000000..43a2f9e1acd7 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/MonitoredSubscriptions_Update.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "requestBody": { + "properties": { + "operation": "AddComplete", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/NewRelic.Observability/monitors/test?api-version=2022-09-01" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..c2a6c6406046 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,203 @@ +{ + "operationId": "Monitors_CreateOrUpdate", + "title": "Monitors_CreateOrUpdate_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "cdlymktqw", + "resource": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "ingestionKey": "wltnimmhqt", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "key8903": {} + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..aba9358151e4 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "Monitors_Delete", + "title": "Monitors_Delete_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..2835260d7a44 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "Monitors_Delete", + "title": "Monitors_Delete_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json new file mode 100644 index 000000000000..9074c283c1ce --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Monitors_GetMetricRules", + "title": "Monitors_GetMetricRules_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "sendMetrics": "Enabled", + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "qnvixg", + "value": "ihyabcsjvhkfzckfjvgvtlhdyvmwge", + "action": "Include" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json new file mode 100644 index 000000000000..f972ad63073b --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "operationId": "Monitors_GetMetricRules", + "title": "Monitors_GetMetricRules_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "sendMetrics": "Disabled", + "filteringTags": [], + "userEmail": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json new file mode 100644 index 000000000000..2b688ffcdbb0 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "operationId": "Monitors_GetMetricStatus", + "title": "Monitors_GetMetricStatus_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json new file mode 100644 index 000000000000..a78966ef8fb0 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "operationId": "Monitors_GetMetricStatus", + "title": "Monitors_GetMetricStatus_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "azureResourceIds": [] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..64dc339e3f3d --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Get_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "operationId": "Monitors_Get", + "title": "Monitors_Get_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "cdlymktqw" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json new file mode 100644 index 000000000000..7a7d17d215c0 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "operationId": "Monitors_ListAppServices", + "title": "Monitors_ListAppServices_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", + "agentVersion": "owxkssnbp", + "agentStatus": "vclwfecbppsfaygdccfu" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json new file mode 100644 index 000000000000..9c0ed8bd898d --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "operationId": "Monitors_ListAppServices", + "title": "Monitors_ListAppServices_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "azureResourceIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..4e47347dac19 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "operationId": "Monitors_ListByResourceGroup", + "title": "Monitors_ListByResourceGroup_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..4fc2f4c35eab --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "operationId": "Monitors_ListBySubscription", + "title": "Monitors_ListBySubscription_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json new file mode 100644 index 000000000000..5d76edda4dbd --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "operationId": "Monitors_ListHosts", + "title": "Monitors_ListHosts_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "request": { + "vmIds": [ + "xzphvxvfmvjrnsgyns" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vmId": "gwyoa", + "agentVersion": "tbinulnoozxnbr", + "agentStatus": "psnjslxwuwtviwzzgqhyzynuxvz" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json new file mode 100644 index 000000000000..0f65c1527f56 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "operationId": "Monitors_ListHosts", + "title": "Monitors_ListHosts_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "request": { + "vmIds": [ + "xzphvxvfmvjrnsgyns" + ], + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json new file mode 100644 index 000000000000..d94881320c24 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "operationId": "Monitors_ListMonitoredResources", + "title": "Monitors_ListMonitoredResources_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "sendingMetrics": "Enabled", + "reasonForMetricsStatus": "k", + "sendingLogs": "Enabled", + "reasonForLogsStatus": "agzxviwuxgr" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json new file mode 100644 index 000000000000..4a9a6f15509b --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "operationId": "Monitors_ListMonitoredResources", + "title": "Monitors_ListMonitoredResources_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [], + "nextLink": null + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json new file mode 100644 index 000000000000..7571cc153092 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "operationId": "Monitors_SwitchBilling", + "title": "Monitors_SwitchBilling_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", + "organizationId": "k", + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json new file mode 100644 index 000000000000..f7c8666f136d --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json @@ -0,0 +1,90 @@ +{ + "operationId": "Monitors_SwitchBilling", + "title": "Monitors_SwitchBilling_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..150f52dd87d3 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_Update_MaximumSet_Gen.json @@ -0,0 +1,126 @@ +{ + "operationId": "Monitors_Update", + "title": "Monitors_Update_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgNewRelic", + "monitorName": "cdlymktqw", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key8903": {} + } + }, + "tags": { + "key164": "jqakdrrmmyzytqu" + }, + "properties": { + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "ingestionKey": "wltnimmhqt", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "newRelicAccountProperties": { + "userId": "vcscxlncofcuduadesd", + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "kwiwfz", + "singleSignOnUrl": "kvseueuljsxmfwpqctz", + "provisioningState": "Accepted" + } + }, + "userInfo": { + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "phoneNumber": "krf", + "country": "hslqnwdanrconqyekwbnttaetv" + }, + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + }, + "identity": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "type": "None", + "userAssignedIdentities": { + "key8903": { + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "clientId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "tags": { + "key6976": "oaxfhf" + }, + "location": "k", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "systemData": { + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json new file mode 100644 index 000000000000..dc1a51f16a66 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Monitors_VmHostPayload", + "title": "Monitors_VmHostPayload_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "ingestionKey": "ltqewhfexphvqgttoevaywrl" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json new file mode 100644 index 000000000000..531031a83a9b --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Monitors_VmHostPayload", + "title": "Monitors_VmHostPayload_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "ingestionKey": "ltqewhfexphvqgttoevaywrl" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..4d2df7c9ecac --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "zhlrjcljiysnufaerhpzg", + "isDataAction": true, + "display": { + "provider": "v", + "resource": "w", + "operation": "ybyzweygkffbydgaowg", + "description": "sekhimcuecttketh" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..1bdb0612b287 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Organizations_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Organizations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..23413608c2c7 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Organizations_List_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "operationId": "Organizations_List", + "title": "Organizations_List_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "organizationId": "tjmcifofzirili", + "organizationName": "orgname", + "billingSource": "AZURE" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Organizations_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Organizations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..8711dbea3150 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Organizations_List_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Organizations_List", + "title": "Organizations_List_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "location": "egh" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Plans_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Plans_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb2bebbeed72 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Plans_List_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "operationId": "Plans_List", + "title": "Plans_List_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "accountId": "pwuxgvrmkk", + "organizationId": "hilawwjz" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "planData": { + "usageType": "PAYG", + "billingCycle": "YEARLY", + "planDetails": "tbbiaga", + "effectiveDate": "2022-12-05T14:11:37.786Z" + }, + "orgCreationSource": "LIFTR", + "accountCreationSource": "LIFTR" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Plans_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Plans_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..6042052d6e68 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/Plans_List_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "operationId": "Plans_List", + "title": "Plans_List_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "organizationId": "hilawwjz" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "orgCreationSource": "NEWRELIC" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..cbc416d81414 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,121 @@ +{ + "operationId": "TagRules_CreateOrUpdate", + "title": "TagRules_CreateOrUpdate_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "resource": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..b21b8c4611ce --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "operationId": "TagRules_CreateOrUpdate", + "title": "TagRules_CreateOrUpdate_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "resource": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a10623330882 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Delete", + "title": "TagRules_Delete_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..0b5c3a8edab9 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Delete", + "title": "TagRules_Delete_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..126b73638fe6 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Get_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "operationId": "TagRules_Get", + "title": "TagRules_Get_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Get_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..2c5e7ceaa1d6 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "operationId": "TagRules_Get", + "title": "TagRules_Get_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..bbc695c88095 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "operationId": "TagRules_ListByNewRelicMonitorResource", + "title": "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + ], + "nextLink": "http://testlink.com" + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json new file mode 100644 index 000000000000..362cc9b1cc62 --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "operationId": "TagRules_ListByNewRelicMonitorResource", + "title": "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3d42d776c2c --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Update_MaximumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "operationId": "TagRules_Update", + "title": "TagRules_Update_MaximumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "properties": { + "properties": { + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": "Enabled", + "sendSubscriptionLogs": "Enabled", + "sendActivityLogs": "Enabled", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + }, + "metricRules": { + "userEmail": "test@testing.com", + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "systemData": { + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z" + } + } + } + } +} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Update_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..fe607956b6fe --- /dev/null +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/examples/TagRules_Update_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Update", + "title": "TagRules_Update_MinimumSet_Gen", + "parameters": { + "api-version": "2023-11-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rgopenapi", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "properties": {} + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + } + } +} diff --git a/specification/newrelic/resource-manager/readme.md b/specification/newrelic/resource-manager/readme.md index e0f611827f9c..833caefd7f68 100644 --- a/specification/newrelic/resource-manager/readme.md +++ b/specification/newrelic/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the newrelic. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-10-01-preview +tag: package-2023-11-01-preview ``` ### Tag: package-2022-07-01-preview @@ -57,6 +57,15 @@ input-file: - NewRelic.Observability/preview/2023-10-01-preview/NewRelic.json ``` +### Tag: package-2023-11-01-preview + +These settings apply only when `--tag=package-2023-11-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-11-01-preview' +input-file: + - NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json +``` + --- # Code Generation diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NHOperationsList.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NHOperationsList.json new file mode 100644 index 000000000000..cf041029a00d --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NHOperationsList.json @@ -0,0 +1,1267 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.NotificationHubs/register/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Microsoft Azure Notification Hub", + "operation": "Registers the NotificationHubs Provider", + "description": "Registers the subscription for the NotifciationHubs resource provider and enables the creation of Namespaces and NotificationHubs" + } + }, + { + "name": "Microsoft.NotificationHubs/unregister/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Microsoft Azure Notification Hub", + "operation": "Unregisters the NotificationHubs Provider", + "description": "Unregisters the subscription for the NotifciationHubs resource provider and enables the creation of Namespaces and NotificationHubs" + } + }, + { + "name": "Microsoft.NotificationHubs/operations/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Microsoft Azure Notification Hub", + "operation": "Notification Hubs provider operations", + "description": "Returns a list of supported operations for Notification Hubs provider" + } + }, + { + "name": "Microsoft.NotificationHubs/operationResults/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Microsoft Azure Notification Hub", + "operation": "Operation results for Notification Hubs provider", + "description": "Returns operation results for Notification Hubs provider" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace", + "operation": "Read diagnostics setting", + "description": "Get Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace", + "operation": "Write diagnostic settings", + "description": "Create or Update Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "The log definition of Namespace", + "operation": "Read Namespace log definitions", + "description": "Gets the available logs for Namespace" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "OperationalLogs", + "displayName": "Operational Logs", + "blobDuration": "PT1H" + } + ] + } + } + }, + { + "name": "Microsoft.NotificationHubs/CheckNamespaceAvailability/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace", + "operation": "Check Namespace name availability.", + "description": "Checks whether or not a given Namespace resource name is available within the NotificationHub service." + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/write", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace", + "operation": "Create Or Update Namespace", + "description": "Create a Namespace Resource and Update its properties. Tags and Capacity of the Namespace are the properties which can be updated." + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace", + "operation": "Get Namespace Resource", + "description": "Get the list of Namespace Resource Description" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/delete", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace", + "operation": "Delete Namespace", + "description": "Delete Namespace Resource" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/authorizationRules/write", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace Authorization Rule", + "operation": "Create or Update Namespace Authorization Rules", + "description": "Create a Namespace level Authorization Rules and update its properties. The Authorization Rules Access Rights, the Primary and Secondary Keys can be updated." + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/authorizationRules/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace Authorization Rule", + "operation": "Get Namespace Authorization Rules", + "description": "Get the list of Namespaces Authorization Rules description." + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/authorizationRules/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace Authorization Rule", + "operation": "Get Namespace Authorization Rules", + "description": "Get the list of Namespaces Authorization Rules description." + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace Authorization Rule", + "operation": "Delete Namespace Authorization Rule", + "description": "Delete Namespace Authorization Rule. The Default Namespace Authorization Rule cannot be deleted." + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace Authorization Rule", + "operation": "Get Namespace Listkeys", + "description": "Get the Connection String to the Namespace" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace Authorization Rule", + "operation": "Namespace Authorization Rule Regenerate Keys", + "description": "Namespace Authorization Rule Regenerate Primary/SecondaryKey, Specify the Key that needs to be regenerated" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/CheckNotificationHubAvailability/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace", + "operation": "Check NotificationHub name availability.", + "description": "Checks whether or not a given NotificationHub name is available inside a Namespace." + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/write", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub", + "operation": "Create or Update Notification Hub", + "description": "Create a Notification Hub and Update its properties. Its properties mainly include PNS Credentials. Authorization Rules and TTL" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/vapidkeys/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub", + "operation": "Get VAPID keys for a Notification Hub", + "description": "Get new pair of VAPID keys for a Notification Hub" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub", + "operation": "Get Notification Hub", + "description": "Get list of Notification Hub Resource Descriptions" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/delete", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub", + "operation": "Delete Notification Hub", + "description": "Delete Notification Hub Resource" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/authorizationRules/write", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub Authorization Rule", + "operation": "Create or Update Notification hub Authorization Rule", + "description": "Create Notification Hub Authorization Rules and Update its properties. The Authorization Rules Access Rights, the Primary and Secondary Keys can be updated." + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/authorizationRules/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub Authorization Rule", + "operation": "Get Notification Hub Authorization Rules", + "description": "Get the list of Notification Hub Authorization Rules" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/authorizationRules/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub Authorization Rule", + "operation": "Get Notification Hub Authorization Rules", + "description": "Get the list of Notification Hub Authorization Rules" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub Authorization Rule", + "operation": "Delete Notification Hub Authorization Rules", + "description": "Delete Notification Hub Authorization Rules" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub Authorization Rule", + "operation": "Get Notification Hub Listkeys", + "description": "Get the Connection String to the Notification Hub" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub Authorization Rule", + "operation": "Notification Hub Authorization Rule Regenerate Keys", + "description": "Notification Hub Authorization Rule Regenerate Primary/SecondaryKey, Specify the Key that needs to be regenerated" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/pnsCredentials/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub PnsCredential", + "operation": "Get Notification Hub PNS Credentials", + "description": "Get All Notification Hub PNS Credentials. This includes, WNS, MPNS, APNS, GCM, Baidu and FcmV1 credentials" + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/debugSend/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "NotificationHub", + "operation": "Send a test push notification.", + "description": "Send a test push notification to 10 matched devices." + } + }, + { + "name": "Microsoft.NotificationHubs/Namespaces/NotificationHubs/metricDefinitions/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace metrics", + "operation": "Get Namespace metrics", + "description": "Get list of Namespace metrics Resource Descriptions" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "registration.all", + "displayName": "Registration Operations", + "displayDescription": "The count of all successful registration operations (creations updates queries and deletions). ", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "registration.create", + "displayName": "Registration Create Operations", + "displayDescription": "The count of all successful registration creations.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "registration.update", + "displayName": "Registration Update Operations", + "displayDescription": "The count of all successful registration updates.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "registration.get", + "displayName": "Registration Read Operations", + "displayDescription": "The count of all successful registration queries.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "registration.delete", + "displayName": "Registration Delete Operations", + "displayDescription": "The count of all successful registration deletions.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "incoming", + "displayName": "Incoming Messages", + "displayDescription": "The count of all successful send API calls. ", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "incoming.scheduled", + "displayName": "Scheduled Push Notifications Sent", + "displayDescription": "Scheduled Push Notifications Sent", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "incoming.scheduled.cancel", + "displayName": "Scheduled Push Notifications Cancelled", + "displayDescription": "Scheduled Push Notifications Cancelled", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "scheduled.pending", + "displayName": "Pending Scheduled Notifications", + "displayDescription": "Pending Scheduled Notifications", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "installation.all", + "displayName": "Installation Management Operations", + "displayDescription": "Installation Management Operations", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "installation.get", + "displayName": "Get Installation Operations", + "displayDescription": "Get Installation Operations", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "installation.upsert", + "displayName": "Create or Update Installation Operations", + "displayDescription": "Create or Update Installation Operations", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "installation.patch", + "displayName": "Patch Installation Operations", + "displayDescription": "Patch Installation Operations", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "installation.delete", + "displayName": "Delete Installation Operations", + "displayDescription": "Delete Installation Operations", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.allpns.success", + "displayName": "Successful notifications", + "displayDescription": "The count of all successful notifications.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.allpns.invalidpayload", + "displayName": "Payload Errors", + "displayDescription": "The count of pushes that failed because the PNS returned a bad payload error.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.allpns.pnserror", + "displayName": "External Notification System Errors", + "displayDescription": "The count of pushes that failed because there was a problem communicating with the PNS (excludes authentication problems).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.allpns.channelerror", + "displayName": "Channel Errors", + "displayDescription": "The count of pushes that failed because the channel was invalid not associated with the correct app throttled or expired.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.allpns.badorexpiredchannel", + "displayName": "Bad or Expired Channel Errors", + "displayDescription": "The count of pushes that failed because the channel/token/registrationId in the registration was expired or invalid.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.success", + "displayName": "WNS Successful Notifications", + "displayDescription": "The count of all successful notifications.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.invalidcredentials", + "displayName": "WNS Authorization Errors (Invalid Credentials)", + "displayDescription": "The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked. (Windows Live does not recognize the credentials).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.badchannel", + "displayName": "WNS Bad Channel Error", + "displayDescription": "The count of pushes that failed because the ChannelURI in the registration was not recognized (WNS status: 404 not found).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.expiredchannel", + "displayName": "WNS Expired Channel Error", + "displayDescription": "The count of pushes that failed because the ChannelURI is expired (WNS status: 410 Gone).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.throttled", + "displayName": "WNS Throttled Notifications", + "displayDescription": "The count of pushes that failed because WNS is throttling this app (WNS status: 406 Not Acceptable).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.tokenproviderunreachable", + "displayName": "WNS Authorization Errors (Unreachable)", + "displayDescription": "Windows Live is not reachable.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.invalidtoken", + "displayName": "WNS Authorization Errors (Invalid Token)", + "displayDescription": "The token provided to WNS is not valid (WNS status: 401 Unauthorized).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.wrongtoken", + "displayName": "WNS Authorization Errors (Wrong Token)", + "displayDescription": "The token provided to WNS is valid but for another application (WNS status: 403 Forbidden). This can happen if the ChannelURI in the registration is associated with another app. Check that the client app is associated with the same app whose credentials are in the notification hub.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.invalidnotificationformat", + "displayName": "WNS Invalid Notification Format", + "displayDescription": "The format of the notification is invalid (WNS status: 400). Note that WNS does not reject all invalid payloads.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.invalidnotificationsize", + "displayName": "WNS Invalid Notification Size Error", + "displayDescription": "The notification payload is too large (WNS status: 413).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.channelthrottled", + "displayName": "WNS Channel Throttled", + "displayDescription": "The notification was dropped because the ChannelURI in the registration is throttled (WNS response header: X-WNS-NotificationStatus:channelThrottled).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.channeldisconnected", + "displayName": "WNS Channel Disconnected", + "displayDescription": "The notification was dropped because the ChannelURI in the registration is throttled (WNS response header: X-WNS-DeviceConnectionStatus: disconnected).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.dropped", + "displayName": "WNS Dropped Notifications", + "displayDescription": "The notification was dropped because the ChannelURI in the registration is throttled (X-WNS-NotificationStatus: dropped but not X-WNS-DeviceConnectionStatus: disconnected).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.pnserror", + "displayName": "WNS Errors", + "displayDescription": "Notification not delivered because of errors communicating with WNS.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.wns.authenticationerror", + "displayName": "WNS Authentication Errors", + "displayDescription": "Notification not delivered because of errors communicating with Windows Live invalid credentials or wrong token.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.apns.success", + "displayName": "APNS Successful Notifications", + "displayDescription": "The count of all successful notifications.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.apns.invalidcredentials", + "displayName": "APNS Authorization Errors", + "displayDescription": "The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.apns.badchannel", + "displayName": "APNS Bad Channel Error", + "displayDescription": "The count of pushes that failed because the token is invalid (APNS status code: 8).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.apns.expiredchannel", + "displayName": "APNS Expired Channel Error", + "displayDescription": "The count of token that were invalidated by the APNS feedback channel.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.apns.invalidnotificationsize", + "displayName": "APNS Invalid Notification Size Error", + "displayDescription": "The count of pushes that failed because the payload was too large (APNS status code: 7).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.apns.pnserror", + "displayName": "APNS Errors", + "displayDescription": "The count of pushes that failed because of errors communicating with APNS.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.gcm.success", + "displayName": "GCM Successful Notifications", + "displayDescription": "The count of all successful notifications.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.gcm.invalidcredentials", + "displayName": "GCM Authorization Errors (Invalid Credentials)", + "displayDescription": "The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.gcm.badchannel", + "displayName": "GCM Bad Channel Error", + "displayDescription": "The count of pushes that failed because the registrationId in the registration was not recognized (GCM result: Invalid Registration).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.gcm.expiredchannel", + "displayName": "GCM Expired Channel Error", + "displayDescription": "The count of pushes that failed because the registrationId in the registration was expired (GCM result: NotRegistered).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.gcm.throttled", + "displayName": "GCM Throttled Notifications", + "displayDescription": "The count of pushes that failed because GCM throttled this app (GCM status code: 501-599 or result:Unavailable).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.gcm.invalidnotificationformat", + "displayName": "GCM Invalid Notification Format", + "displayDescription": "The count of pushes that failed because the payload was not formatted correctly (GCM result: InvalidDataKey or InvalidTtl).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.gcm.invalidnotificationsize", + "displayName": "GCM Invalid Notification Size Error", + "displayDescription": "The count of pushes that failed because the payload was too large (GCM result: MessageTooBig).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.gcm.wrongchannel", + "displayName": "GCM Wrong Channel Error", + "displayDescription": "The count of pushes that failed because the registrationId in the registration is not associated to the current app (GCM result: InvalidPackageName).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.gcm.pnserror", + "displayName": "GCM Errors", + "displayDescription": "The count of pushes that failed because of errors communicating with GCM.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.gcm.authenticationerror", + "displayName": "GCM Authentication Errors", + "displayDescription": "The count of pushes that failed because the PNS did not accept the provided credentials the credentials are blocked or the SenderId is not correctly configured in the app (GCM result: MismatchedSenderId).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.mpns.success", + "displayName": "MPNS Successful Notifications", + "displayDescription": "The count of all successful notifications.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.mpns.invalidcredentials", + "displayName": "MPNS Invalid Credentials", + "displayDescription": "The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.mpns.badchannel", + "displayName": "MPNS Bad Channel Error", + "displayDescription": "The count of pushes that failed because the ChannelURI in the registration was not recognized (MPNS status: 404 not found).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.mpns.throttled", + "displayName": "MPNS Throttled Notifications", + "displayDescription": "The count of pushes that failed because MPNS is throttling this app (WNS MPNS: 406 Not Acceptable).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.mpns.invalidnotificationformat", + "displayName": "MPNS Invalid Notification Format", + "displayDescription": "The count of pushes that failed because the payload of the notification was too large.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.mpns.channeldisconnected", + "displayName": "MPNS Channel Disconnected", + "displayDescription": "The count of pushes that failed because the ChannelURI in the registration was disconnected (MPNS status: 412 not found).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.mpns.dropped", + "displayName": "MPNS Dropped Notifications", + "displayDescription": "The count of pushes that were dropped by MPNS (MPNS response header: X-NotificationStatus: QueueFull or Suppressed).", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.mpns.pnserror", + "displayName": "MPNS Errors", + "displayDescription": "The count of pushes that failed because of errors communicating with MPNS.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "outgoing.mpns.authenticationerror", + "displayName": "MPNS Authentication Errors", + "displayDescription": "The count of pushes that failed because the PNS did not accept the provided credentials or the credentials are blocked.", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "notificationhub.pushes", + "displayName": "All Outgoing Notifications", + "displayDescription": "All outgoing notifications of the notification hub", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "incoming.all.requests", + "displayName": "All Incoming Requests", + "displayDescription": "Total incoming requests for a notification hub", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + }, + { + "name": "incoming.all.failedrequests", + "displayName": "All Incoming Failed Requests", + "displayDescription": "Total incoming failed requests for a notification hub", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "PT1M", + "blobDuration": "P30D" + } + ], + "fillGapWithZero": true + } + ] + } + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/privateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Namespace", + "operation": "Approve Private Endpoint Connection", + "description": "Approve Private Endpoint Connection" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Private Endpoint Connection Proxy", + "operation": "Validate Private Endpoint Connection Proxy", + "description": "Validate Private Endpoint Connection Proxy" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Private Endpoint Connection Proxy", + "operation": "Get Private Endpoint Connection Proxy", + "description": "Get Private Endpoint Connection Proxy" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Private Endpoint Connection Proxy", + "operation": "Create Private Endpoint Connection Proxy", + "description": "Create Private Endpoint Connection Proxy" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Private Endpoint Connection Proxy", + "operation": "Delete Private Endpoint Connection Proxy", + "description": "Delete Private Endpoint Connection Proxy" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/privateEndpointConnectionProxies/operationstatus/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Private Endpoint Connection Proxy", + "operation": "Private endpoint operation status", + "description": "Get the status of an asynchronous private endpoint operation" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Private Endpoint Connection", + "operation": "Get Private Endpoint Connection", + "description": "Get Private Endpoint Connection" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Private Endpoint Connection", + "operation": "Create or Update Private Endpoint Connection", + "description": "Create or Update Private Endpoint Connection" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Private Endpoint Connection", + "operation": "Removes Private Endpoint Connection", + "description": "Removes Private Endpoint Connection" + } + }, + { + "name": "Microsoft.NotificationHubs/namespaces/privateEndpointConnections/operationstatus/read", + "display": { + "provider": "Microsoft Azure Notification Hub", + "resource": "Private Endpoint Connection", + "operation": "Removes Private Endpoint Connection", + "description": "Removes Private Endpoint Connection" + } + } + ] + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleCreateOrUpdate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleCreateOrUpdate.json new file mode 100644 index 000000000000..8725dfdd5af8 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleCreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "sdk-AuthRules-1788", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "location": "West Europe", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "rights": [ + "Listen", + "Send" + ], + "modifiedTime": "2023-04-26T10:09:19.9675121+00:00", + "createdTime": "2023-04-26T10:09:19.9675121+00:00" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/NewAuthorizationRule", + "name": "NewAuthorizationRule", + "type": "Microsoft.NotificationHubs/namespaces/authorizationRules" + } + }, + "201": { + "body": { + "properties": { + "rights": [ + "Listen", + "Send" + ], + "modifiedTime": "2023-04-26T10:09:19.9675121+00:00", + "createdTime": "2023-04-26T10:09:19.9675121+00:00" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/NewAuthorizationRule", + "name": "NewAuthorizationRule", + "type": "Microsoft.NotificationHubs/namespaces/authorizationRules" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleDelete.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleDelete.json new file mode 100644 index 000000000000..14bc415c4a0d --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "RootManageSharedAccessKey", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleGet.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleGet.json new file mode 100644 index 000000000000..ccdd755a75b4 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "RootManageSharedAccessKey", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "properties": { + "rights": [ + "Manage", + "Listen", + "Send" + ], + "modifiedTime": "2023-04-26T10:19:36.3315279+00:00", + "createdTime": "2023-04-26T10:19:36.3315279+00:00" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.NotificationHubs/namespaces/authorizationRules" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleList.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleList.json new file mode 100644 index 000000000000..4aef36d53853 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "rights": [ + "Manage", + "Listen", + "Send" + ], + "modifiedTime": "2023-04-26T06:10:44.0407987+00:00", + "createdTime": "2023-04-26T06:10:44.0407982+00:00" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/RootManageSharedAccessKey", + "name": "RootManageSharedAccessKey", + "type": "Microsoft.NotificationHubs/namespaces/authorizationRules" + }, + { + "properties": { + "rights": [ + "Listen", + "Send" + ], + "modifiedTime": "2023-04-26T10:09:19.9675121+00:00", + "createdTime": "2023-04-26T10:09:19.9675121+00:00" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/authorizationRules/NewAuthorizationRule", + "name": "NewAuthorizationRule", + "type": "Microsoft.NotificationHubs/namespaces/authorizationRules" + } + ] + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleListKeys.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleListKeys.json new file mode 100644 index 000000000000..54077074157f --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleListKeys.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "RootManageSharedAccessKey", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=############################################", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "RootManageSharedAccessKey" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleRegenerateKey.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..fa327b2ad97a --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/AuthorizationRuleRegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "authorizationRuleName": "RootManageSharedAccessKey", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "policyKey": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=########################################", + "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=########################################", + "primaryKey": "########################################", + "secondaryKey": "########################################", + "keyName": "RootManageSharedAccessKey" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/CheckAvailability.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/CheckAvailability.json new file mode 100644 index 000000000000..363716efd3b3 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/CheckAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "name": "sdk-Namespace-2924" + } + }, + "responses": { + "200": { + "body": { + "isAvailiable": true, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/providers/Microsoft.NotificationHubs/namespaces/sdk-Namespace-2924", + "name": "sdk-Namespace-2924", + "type": "Microsoft.NotificationHubs/namespaces/checkNamespaceAvailability" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/CreateOrUpdate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/CreateOrUpdate.json new file mode 100644 index 000000000000..1994e380fe58 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/CreateOrUpdate.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "location": "South Central US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "zoneRedundancy": "Enabled", + "networkAcls": { + "ipRules": [ + { + "ipMask": "185.48.100.00/24", + "rights": [ + "Manage", + "Send", + "Listen" + ] + } + ], + "publicNetworkRule": { + "rights": [ + "Listen" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "East US", + "sku": { + "name": "Standard" + }, + "properties": { + "name": "nh-sdk-ns", + "provisioningState": "Succeeded", + "status": "Created", + "enabled": true, + "critical": false, + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "createdAt": "2023-04-26T06:10:44.01+00:00", + "updatedAt": "2023-04-26T06:16:17.697+00:00", + "namespaceType": "NotificationHub", + "publicNetworkAccess": "Enabled", + "zoneRedundancy": "Enabled", + "networkAcls": { + "ipRules": [ + { + "ipMask": "185.48.100.00/24", + "rights": [ + "Manage", + "Send", + "Listen" + ] + } + ], + "publicNetworkRule": { + "rights": [ + "Listen" + ] + } + }, + "serviceBusEndpoint": "https://nh-sdk-ns.servicebus.windows.net:443/", + "privateEndpointConnections": [] + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns", + "name": "nh-sdk-ns", + "type": "Microsoft.NotificationHubs/namespaces", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "201": { + "body": { + "location": "East US", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "InProgress", + "publicNetworkAccess": "Enabled", + "zoneRedundancy": "Enabled", + "networkAcls": { + "ipRules": [ + { + "ipMask": "185.48.100.00/24", + "rights": [ + "Manage", + "Send", + "Listen" + ] + } + ], + "publicNetworkRule": { + "rights": [ + "Listen" + ] + } + } + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns", + "name": "nh-sdk-ns", + "type": "Microsoft.NotificationHubs/namespaces", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/Delete.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/Delete.json new file mode 100644 index 000000000000..bb09c5fa1001 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/Get.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/Get.json new file mode 100644 index 000000000000..8725c9cd0280 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "location": "East US", + "sku": { + "name": "Standard" + }, + "properties": { + "name": "nh-sdk-ns", + "provisioningState": "Succeeded", + "status": "Created", + "enabled": true, + "critical": false, + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "createdAt": "2023-04-26T06:10:44.01+00:00", + "updatedAt": "2023-04-26T06:10:44.03+00:00", + "namespaceType": "NotificationHub", + "publicNetworkAccess": "Enabled", + "networkAcls": { + "ipRules": [ + { + "ipMask": "185.48.100.00/24", + "rights": [ + "Manage", + "Send", + "Listen" + ] + } + ], + "publicNetworkRule": { + "rights": [ + "Listen" + ] + } + }, + "serviceBusEndpoint": "https://nh-sdk-ns.servicebus.windows.net:443/", + "privateEndpointConnections": [] + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns", + "name": "nh-sdk-ns", + "type": "Microsoft.NotificationHubs/namespaces", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/ListByResourceGroup.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/ListByResourceGroup.json new file mode 100644 index 000000000000..92a6479d5efb --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/ListByResourceGroup.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "resourceGroupName": "5ktrial" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "East US", + "sku": { + "name": "Standard" + }, + "properties": { + "name": "namespace-1", + "provisioningState": "Succeeded", + "status": "Created", + "enabled": true, + "critical": false, + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "createdAt": "2023-04-26T06:10:44.01+00:00", + "updatedAt": "2023-04-26T06:10:44.03+00:00", + "namespaceType": "NotificationHub", + "publicNetworkAccess": "Enabled", + "networkAcls": { + "ipRules": [ + { + "ipMask": "185.48.100.00/24", + "rights": [ + "Manage", + "Send", + "Listen" + ] + } + ], + "publicNetworkRule": { + "rights": [ + "Listen" + ] + } + }, + "serviceBusEndpoint": "https://namespace-1.servicebus.windows.net:443/", + "privateEndpointConnections": [] + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/namespace-1", + "name": "namespace-2", + "type": "Microsoft.NotificationHubs/namespaces", + "tags": {} + }, + { + "location": "East US", + "sku": { + "name": "Standard" + }, + "properties": { + "name": "namespace-2", + "provisioningState": "Succeeded", + "status": "Created", + "enabled": true, + "critical": false, + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "createdAt": "2023-04-26T06:10:44.01+00:00", + "updatedAt": "2023-04-26T06:10:44.03+00:00", + "namespaceType": "NotificationHub", + "publicNetworkAccess": "Enabled", + "networkAcls": { + "ipRules": [], + "publicNetworkRule": { + "rights": [ + "Manage", + "Listen", + "Send" + ] + } + }, + "serviceBusEndpoint": "https://namespace-2.servicebus.windows.net:443/", + "privateEndpointConnections": [] + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/namespace-2", + "name": "namespace-2", + "type": "Microsoft.NotificationHubs/namespaces", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/providers/Microsoft.NotificationHubs/namespaces?api-version=2023-10-01-preview&$count=2&$skipToken=##################" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/ListBySubscription.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/ListBySubscription.json new file mode 100644 index 000000000000..da07e8ee5cf9 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/ListBySubscription.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "East US", + "sku": { + "name": "Standard" + }, + "properties": { + "name": "namespace-1", + "provisioningState": "Succeeded", + "status": "Created", + "enabled": true, + "critical": false, + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "createdAt": "2023-04-26T06:10:44.01+00:00", + "updatedAt": "2023-04-26T06:10:44.03+00:00", + "namespaceType": "NotificationHub", + "publicNetworkAccess": "Enabled", + "networkAcls": { + "ipRules": [ + { + "ipMask": "185.48.100.00/24", + "rights": [ + "Manage", + "Send", + "Listen" + ] + } + ], + "publicNetworkRule": { + "rights": [ + "Listen" + ] + } + }, + "serviceBusEndpoint": "https://namespace-1.servicebus.windows.net:443/", + "privateEndpointConnections": [] + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/namespace-1", + "name": "namespace-2", + "type": "Microsoft.NotificationHubs/namespaces", + "tags": {} + }, + { + "location": "East US", + "sku": { + "name": "Standard" + }, + "properties": { + "name": "namespace-2", + "provisioningState": "Succeeded", + "status": "Created", + "enabled": true, + "critical": false, + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "createdAt": "2023-04-26T06:10:44.01+00:00", + "updatedAt": "2023-04-26T06:10:44.03+00:00", + "namespaceType": "NotificationHub", + "publicNetworkAccess": "Enabled", + "networkAcls": { + "ipRules": [], + "publicNetworkRule": { + "rights": [ + "Manage", + "Listen", + "Send" + ] + } + }, + "serviceBusEndpoint": "https://namespace-2.servicebus.windows.net:443/", + "privateEndpointConnections": [] + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/namespace-2", + "name": "namespace-2", + "type": "Microsoft.NotificationHubs/namespaces", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/providers/Microsoft.NotificationHubs/namespaces?api-version=2023-10-01-preview&$count=2&$skipToken=##################" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PnsCredentialsGet.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PnsCredentialsGet.json new file mode 100644 index 000000000000..89994b651bea --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PnsCredentialsGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns", + "name": "nh-sdk-hub", + "type": "Microsoft.NotificationHubs/namespaces/pnsCredentials", + "properties": { + "mpnsCredential": { + "properties": { + "thumbprint": "#################################" + } + } + } + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionDelete.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..851ef04cf70c --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "privateEndpointConnectionName": "nh-sdk-ns.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "202": { + "headers": { + "Location": "https://nh-sdk-ns.servicebus.windows.net/operationXYZ" + } + }, + "204": {} + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionGet.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..f0f757601b68 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "privateEndpointConnectionName": "nh-sdk-ns.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.Network/privateEndpoints/demo-private-endpoint" + }, + "groupIds": [ + "namespace" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/privateEndpointConnections/nh-sdk-ns.4fdb3a25-664d-42f1-bde2-f8c2f8e0b3a1", + "name": "nh-sdk-ns.4fdb3a25-664d-42f1-bde2-f8c2f8e0b3a1", + "type": "Microsoft.NotificationHubs/Namespaces/PrivateEndpointConnections" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionList.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionList.json new file mode 100644 index 000000000000..eaa1089566e8 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.Network/privateEndpoints/demo-private-endpoint" + }, + "groupIds": [ + "namespace" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/privateEndpointConnections/nh-sdk-ns.4fdb3a25-664d-42f1-bde2-f8c2f8e0b3a1", + "name": "nh-sdk-ns.4fdb3a25-664d-42f1-bde2-f8c2f8e0b3a1", + "type": "Microsoft.NotificationHubs/Namespaces/PrivateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionUpdate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..8f515d7fd81e --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "privateEndpointConnectionName": "nh-sdk-ns.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "parameters": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourcegroups/5ktrial/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "namespace" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourcegroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/privateEndpointConnections/nh-sdk-ns.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "nh-sdk-ns.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.NotificationHubs/namespaces/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourcegroups/5ktrial/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "groupIds": [ + "namespace" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourcegroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/privateEndpointConnections/nh-sdk-ns.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "nh-sdk-ns.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.NotificationHubs/namespaces/privateEndpointConnections" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateLinkResourceGet.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateLinkResourceGet.json new file mode 100644 index 000000000000..f2f1afe7dfe0 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateLinkResourceGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subResourceName": "namespace", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "namespace", + "requiredMembers": [ + "namespace" + ], + "requiredZoneNames": [ + "privatelink.servicebus.windows.net", + "privatelink.notificationhub.windows.net" + ] + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/privateLinkResources/namespace", + "name": "namespace", + "type": "Microsoft.NotificationHubs/namespaces/privateLinkResources" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateLinkResourceList.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateLinkResourceList.json new file mode 100644 index 000000000000..823a3a762d36 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/PrivateLinkResourceList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "namespace", + "requiredMembers": [ + "namespace" + ], + "requiredZoneNames": [ + "privatelink.servicebus.windows.net", + "privatelink.notificationhub.windows.net" + ] + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/privateLinkResources/namespace", + "name": "namespace", + "type": "Microsoft.NotificationHubs/namespaces/privateLinkResources" + } + ] + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/Update.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/Update.json new file mode 100644 index 000000000000..c467e7415cac --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/Namespaces/Update.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "sku": { + "name": "Free" + }, + "tags": { + "tag1": "value3" + }, + "properties": { + "pnsCredentials": { + "gcmCredential": { + "properties": { + "gcmEndpoint": "https://fcm.googleapis.com/fcm/send", + "googleApiKey": "#############################" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "East US", + "sku": { + "name": "Free" + }, + "properties": { + "name": "nh-sdk-ns", + "provisioningState": "Succeeded", + "status": "Created", + "enabled": true, + "critical": false, + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "createdAt": "2023-04-26T06:10:44.01+00:00", + "updatedAt": "2023-04-26T06:10:44.03+00:00", + "namespaceType": "NotificationHub", + "publicNetworkAccess": "Enabled", + "networkAcls": { + "ipRules": [ + { + "ipMask": "185.48.100.00/24", + "rights": [ + "Manage", + "Send", + "Listen" + ] + } + ], + "publicNetworkRule": { + "rights": [ + "Listen" + ] + } + }, + "serviceBusEndpoint": "https://nh-sdk-ns.servicebus.windows.net:443/", + "privateEndpointConnections": [] + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns", + "name": "nh-sdk-ns", + "type": "Microsoft.NotificationHubs/namespaces", + "tags": { + "tag1": "value3" + } + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleCreateOrUpdate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleCreateOrUpdate.json new file mode 100644 index 000000000000..cc4b121add2d --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleCreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "MyManageSharedAccessKey", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "properties": { + "rights": [ + "Listen", + "Send" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "rights": [ + "Listen", + "Send" + ], + "modifiedTime": "2023-04-26T12:24:40.5863818+00:00", + "createdTime": "2023-04-26T12:24:40.5863818+00:00" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test/authorizationRules/MyManageSharedAccessKey", + "name": "MyManageSharedAccessKey", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules" + } + }, + "201": { + "body": { + "properties": { + "rights": [ + "Listen", + "Send" + ], + "modifiedTime": "2023-04-26T12:24:40.5863818+00:00", + "createdTime": "2023-04-26T12:24:40.5863818+00:00" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test/authorizationRules/MyManageSharedAccessKey", + "name": "MyManageSharedAccessKey", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleDelete.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleDelete.json new file mode 100644 index 000000000000..b1fe51cad116 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "DefaultListenSharedAccessSignature", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleGet.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleGet.json new file mode 100644 index 000000000000..346b10db3b35 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "DefaultListenSharedAccessSignature", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "properties": { + "rights": [ + "Listen", + "Send" + ], + "modifiedTime": "2023-04-26T12:24:40.5863818+00:00", + "createdTime": "2023-04-26T12:24:40.5863818+00:00" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test/authorizationRules/DefaultListenSharedAccessSignature", + "name": "DefaultListenSharedAccessSignature", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleList.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleList.json new file mode 100644 index 000000000000..1c3d0227ea7b --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "rights": [ + "Listen" + ], + "modifiedTime": "2023-04-26T10:43:00.5320368+00:00", + "createdTime": "2023-04-26T10:43:00.5320365+00:00" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test/authorizationRules/DefaultListenSharedAccessSignature", + "name": "DefaultListenSharedAccessSignature", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules" + }, + { + "properties": { + "rights": [ + "Manage", + "Listen", + "Send" + ], + "modifiedTime": "2023-04-26T10:43:00.5320387+00:00", + "createdTime": "2023-04-26T10:43:00.5320386+00:00" + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test/authorizationRules/DefaultFullSharedAccessSignature", + "name": "DefaultFullSharedAccessSignature", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/authorizationRules" + } + ] + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleListKeys.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleListKeys.json new file mode 100644 index 000000000000..945ee73c6717 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleListKeys.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "sdk-AuthRules-5800", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-notificationHubs-2317", + "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-notificationHubs-2317", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "sdk-AuthRules-5800" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleRegenerateKey.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleRegenerateKey.json new file mode 100644 index 000000000000..59c2254620d9 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/AuthorizationRuleRegenerateKey.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "authorizationRuleName": "DefaultListenSharedAccessSignature", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "policyKey": "PrimaryKey" + } + }, + "responses": { + "200": { + "body": { + "primaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-notificationHubs-2317", + "secondaryConnectionString": "Endpoint=sb://nh-sdk-ns.servicebus.windows-int.net/;SharedAccessKeyName=sdk-AuthRules-5800;SharedAccessKey=############################################;EntityPath=sdk-notificationHubs-2317", + "primaryKey": "############################################", + "secondaryKey": "############################################", + "keyName": "DefaultListenSharedAccessSignature" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/CheckAvailability.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/CheckAvailability.json new file mode 100644 index 000000000000..267065b318cc --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/CheckAvailability.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "namespaceName": "locp-newns", + "resourceGroupName": "5ktrial", + "parameters": { + "name": "sdktest", + "location": "West Europe" + } + }, + "responses": { + "200": { + "body": { + "isAvailiable": true, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/sdktest", + "name": "sdktest", + "type": "Microsoft.NotificationHubs/namespaces/checkNamespaceAvailability" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/CreateOrUpdate.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/CreateOrUpdate.json new file mode 100644 index 000000000000..3e777ea51f5b --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/CreateOrUpdate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "notificationHubName": "nh-sdk-hub", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "location": "East US", + "properties": { + "name": "test", + "registrationTtl": "10675199.02:48:05.4775807", + "dailyMaxActiveDevices": 0 + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test", + "name": "test", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "tags": { + "hubTag1": "hubTagValue1", + "hubTag2": "hubTagValue2" + } + } + }, + "201": { + "body": { + "location": "East US", + "properties": { + "name": "test", + "registrationTtl": "10675199.02:48:05.4775807", + "dailyMaxActiveDevices": 0 + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test", + "name": "test", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "tags": { + "hubTag1": "hubTagValue1", + "hubTag2": "hubTagValue2" + } + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/DebugSend.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/DebugSend.json new file mode 100644 index 000000000000..28245c7c9379 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/DebugSend.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "notificationHubName": "nh-sdk-hub", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "data": { + "message": "Hello" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "success": 0, + "failure": 0, + "results": [] + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test", + "name": "test", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/debugSend" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/Delete.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/Delete.json new file mode 100644 index 000000000000..b7342a54b921 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "notificationHubName": "nh-sdk-hub", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/Get.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/Get.json new file mode 100644 index 000000000000..8fa02c061ee3 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "notificationHubName": "nh-sdk-hub", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "location": "East US", + "properties": { + "name": "test", + "registrationTtl": "10675199.02:48:05.4775807", + "dailyMaxActiveDevices": 0 + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test", + "name": "test", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "tags": { + "hubTag1": "hubTagValue1", + "hubTag2": "hubTagValue2" + } + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/List.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/List.json new file mode 100644 index 000000000000..2cd95321da48 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "5ktrial", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "East US", + "properties": { + "name": "test", + "registrationTtl": "10675199.02:48:05.4775807", + "dailyMaxActiveDevices": 0 + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test", + "name": "test", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "tags": { + "hubTag1": "hubTagValue1", + "hubTag2": "hubTagValue2" + } + } + ] + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/PnsCredentialsGet.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/PnsCredentialsGet.json new file mode 100644 index 000000000000..004dc01c435a --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/PnsCredentialsGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceGroupName": "5ktrial", + "namespaceName": "nh-sdk-ns", + "notificationHubName": "nh-sdk-hub", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40" + }, + "responses": { + "200": { + "body": { + "properties": { + "gcmCredential": { + "properties": { + "gcmEndpoint": "https://fcm.googleapis.com/fcm/send", + "googleApiKey": "###################################" + } + } + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test", + "name": "test", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs/pnsCredentials" + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/Update.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/Update.json new file mode 100644 index 000000000000..804299805c7b --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/examples/NotificationHubs/Update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "namespaceName": "nh-sdk-ns", + "resourceGroupName": "sdkresourceGroup", + "notificationHubName": "sdk-notificationHubs-8708", + "api-version": "2023-10-01-preview", + "subscriptionId": "29cfa613-cbbc-4512-b1d6-1b3a92c7fa40", + "parameters": { + "properties": { + "registrationTtl": "10675199.02:48:05.4775807", + "gcmCredential": { + "properties": { + "gcmEndpoint": "https://fcm.googleapis.com/fcm/send", + "googleApiKey": "###################################" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "East US", + "properties": { + "name": "test", + "registrationTtl": "10675199.02:48:05.4775807", + "dailyMaxActiveDevices": 0 + }, + "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test", + "name": "test", + "type": "Microsoft.NotificationHubs/namespaces/notificationHubs", + "tags": { + "hubTag1": "hubTagValue1", + "hubTag2": "hubTagValue2" + } + } + } + } +} diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json new file mode 100644 index 000000000000..7dc9dc85bca7 --- /dev/null +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json @@ -0,0 +1,3665 @@ +{ + "swagger": "2.0", + "info": { + "title": "NotificationHubs RP Client", + "description": "Microsoft Notification Hubs Resource Provider REST API.", + "version": "2023-10-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/checkNotificationHubAvailability": { + "post": { + "tags": [ + "Hubs" + ], + "summary": "Checks the availability of the given notificationHub in a namespace.", + "operationId": "NotificationHubs_CheckNotificationHubAvailability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request content.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResult" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_CheckNotificationHubAvailability": { + "$ref": "./examples/NotificationHubs/CheckAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}": { + "get": { + "tags": [ + "Hubs" + ], + "summary": "Gets the notification hub.", + "operationId": "NotificationHubs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotificationHubResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_Get": { + "$ref": "./examples/NotificationHubs/Get.json" + } + } + }, + "put": { + "tags": [ + "Hubs" + ], + "summary": "Creates/Update a NotificationHub in a namespace.", + "operationId": "NotificationHubs_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request content.", + "required": true, + "schema": { + "$ref": "#/definitions/NotificationHubResource" + } + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/NotificationHubResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NotificationHubResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_CreateOrUpdate": { + "$ref": "./examples/NotificationHubs/CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Hubs" + ], + "summary": "Patch a NotificationHub in a namespace.", + "operationId": "NotificationHubs_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request content.", + "required": true, + "schema": { + "$ref": "#/definitions/NotificationHubPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotificationHubResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_Update": { + "$ref": "./examples/NotificationHubs/Update.json" + } + } + }, + "delete": { + "tags": [ + "Hubs" + ], + "summary": "Deletes a notification hub associated with a namespace.", + "operationId": "NotificationHubs_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_Delete": { + "$ref": "./examples/NotificationHubs/Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs": { + "get": { + "tags": [ + "Hubs" + ], + "summary": "Lists the notification hubs associated with a namespace.", + "operationId": "NotificationHubs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "in": "query", + "name": "$skipToken", + "description": "Continuation token.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Page size.", + "type": "integer", + "format": "int32", + "default": 100 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotificationHubListResult" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "itemName": "value", + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NotificationHubs_List": { + "$ref": "./examples/NotificationHubs/List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/debugsend": { + "post": { + "tags": [ + "Hubs" + ], + "summary": "Test send a push notification.", + "operationId": "NotificationHubs_DebugSend", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DebugSendResponse" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_DebugSend": { + "$ref": "./examples/NotificationHubs/DebugSend.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Hubs" + ], + "summary": "Creates/Updates an authorization rule for a NotificationHub", + "operationId": "NotificationHubs_CreateOrUpdateAuthorizationRule", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "#/parameters/AuthorizationRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request content.", + "required": true, + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" + } + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_CreateOrUpdateAuthorizationRule": { + "$ref": "./examples/NotificationHubs/AuthorizationRuleCreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Hubs" + ], + "summary": "Deletes a notificationHub authorization rule", + "operationId": "NotificationHubs_DeleteAuthorizationRule", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "#/parameters/AuthorizationRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_DeleteAuthorizationRule": { + "$ref": "./examples/NotificationHubs/AuthorizationRuleDelete.json" + } + } + }, + "get": { + "tags": [ + "Hubs" + ], + "summary": "Gets an authorization rule for a NotificationHub by name.", + "operationId": "NotificationHubs_GetAuthorizationRule", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "#/parameters/AuthorizationRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_GetAuthorizationRule": { + "$ref": "./examples/NotificationHubs/AuthorizationRuleGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules": { + "get": { + "tags": [ + "Hubs" + ], + "summary": "Gets the authorization rules for a NotificationHub.", + "operationId": "NotificationHubs_ListAuthorizationRules", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleListResult" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "itemName": "value", + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NotificationHubs_ListAuthorizationRules": { + "$ref": "./examples/NotificationHubs/AuthorizationRuleList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "Hubs" + ], + "summary": "Gets the Primary and Secondary ConnectionStrings to the NotificationHub", + "operationId": "NotificationHubs_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "#/parameters/AuthorizationRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceListKeys" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_ListKeys": { + "$ref": "./examples/NotificationHubs/AuthorizationRuleListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Hubs" + ], + "summary": "Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule", + "operationId": "NotificationHubs_RegenerateKeys", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "#/parameters/AuthorizationRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request content.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyKeyResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceListKeys" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_RegenerateKeys": { + "$ref": "./examples/NotificationHubs/AuthorizationRuleRegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/pnsCredentials": { + "post": { + "tags": [ + "Hubs" + ], + "summary": "Lists the PNS Credentials associated with a notification hub.", + "operationId": "NotificationHubs_GetPnsCredentials", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/HubName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PnsCredentialsResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationHubs_GetPnsCredentials": { + "$ref": "./examples/NotificationHubs/PnsCredentialsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/checkNamespaceAvailability": { + "post": { + "tags": [ + "Namespaces" + ], + "summary": "Checks the availability of the given service namespace across all Azure subscriptions. This is useful because the domain name is created based on the service namespace name.", + "operationId": "Namespaces_CheckAvailability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request content.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResult" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_CheckAvailability": { + "$ref": "./examples/Namespaces/CheckAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}": { + "get": { + "tags": [ + "Namespaces" + ], + "summary": "Returns the given namespace.", + "operationId": "Namespaces_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NamespaceResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_Get": { + "$ref": "./examples/Namespaces/Get.json" + } + } + }, + "put": { + "tags": [ + "Namespaces" + ], + "summary": "Creates / Updates a Notification Hub namespace. This operation is idempotent.", + "operationId": "Namespaces_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request content.", + "required": true, + "schema": { + "$ref": "#/definitions/NamespaceResource" + } + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/NamespaceResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NamespaceResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_CreateOrUpdate": { + "$ref": "./examples/Namespaces/CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "summary": "Patches the existing namespace.", + "operationId": "Namespaces_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request content.", + "required": true, + "schema": { + "$ref": "#/definitions/NamespacePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NamespaceResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_Update": { + "$ref": "./examples/Namespaces/Update.json" + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "summary": "Deletes an existing namespace. This operation also removes all associated notificationHubs under the namespace.", + "operationId": "Namespaces_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_Delete": { + "$ref": "./examples/Namespaces/Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NotificationHubs/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "summary": "Lists all the available namespaces within the subscription.", + "operationId": "Namespaces_ListAll", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for subsequent requests.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32", + "default": 100 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NamespaceListResult" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "itemName": "value", + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Namespaces_ListAll": { + "$ref": "./examples/Namespaces/ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "summary": "Lists the available namespaces within a resource group.", + "operationId": "Namespaces_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for subsequent requests.", + "type": "string" + }, + { + "in": "query", + "name": "$top", + "description": "Maximum number of results to return.", + "type": "integer", + "format": "int32", + "default": 100 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NamespaceListResult" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "itemName": "value", + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Namespaces_List": { + "$ref": "./examples/Namespaces/ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "summary": "Creates an authorization rule for a namespace", + "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/AuthorizationRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request content.", + "required": true, + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" + } + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_CreateOrUpdateAuthorizationRule": { + "$ref": "./examples/Namespaces/AuthorizationRuleCreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "summary": "Deletes a namespace authorization rule", + "operationId": "Namespaces_DeleteAuthorizationRule", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/AuthorizationRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_DeleteAuthorizationRule": { + "$ref": "./examples/Namespaces/AuthorizationRuleDelete.json" + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "summary": "Gets an authorization rule for a namespace by name.", + "operationId": "Namespaces_GetAuthorizationRule", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/AuthorizationRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_GetAuthorizationRule": { + "$ref": "./examples/Namespaces/AuthorizationRuleGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules": { + "get": { + "tags": [ + "Namespaces" + ], + "summary": "Gets the authorization rules for a namespace.", + "operationId": "Namespaces_ListAuthorizationRules", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleListResult" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "itemName": "value", + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Namespaces_ListAuthorizationRules": { + "$ref": "./examples/Namespaces/AuthorizationRuleList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "Namespaces" + ], + "summary": "Gets the Primary and Secondary ConnectionStrings to the namespace.", + "operationId": "Namespaces_ListKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/AuthorizationRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceListKeys" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_ListKeys": { + "$ref": "./examples/Namespaces/AuthorizationRuleListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Namespaces" + ], + "summary": "Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule", + "operationId": "Namespaces_RegenerateKeys", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/AuthorizationRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Request content.", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyKeyResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceListKeys" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_RegenerateKeys": { + "$ref": "./examples/Namespaces/AuthorizationRuleRegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/pnsCredentials": { + "post": { + "tags": [ + "Namespaces" + ], + "summary": "Lists the PNS credentials associated with a namespace.", + "operationId": "Namespaces_GetPnsCredentials", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PnsCredentialsResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Namespaces_GetPnsCredentials": { + "$ref": "./examples/Namespaces/PnsCredentialsGet.json" + } + } + } + }, + "/providers/Microsoft.NotificationHubs/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all available Notification Hubs operations.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "itemName": "value", + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/NHOperationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "PrivateLink" + ], + "summary": "Approves or rejects Private Endpoint Connection.\r\nThis is a public API that can be called directly by Notification Hubs users.", + "operationId": "PrivateEndpointConnections_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "Description of the Private Endpoint Connection resource.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Update": { + "$ref": "./examples/Namespaces/PrivateEndpointConnectionUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "PrivateLink" + ], + "summary": "Deletes the Private Endpoint Connection.\r\nThis is a public API that can be called directly by Notification Hubs users.", + "operationId": "PrivateEndpointConnections_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/Namespaces/PrivateEndpointConnectionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "PrivateLink" + ], + "summary": "Returns a Private Endpoint Connection with a given name. \r\nThis is a public API that can be called directly by Notification Hubs users.", + "operationId": "PrivateEndpointConnections_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get": { + "$ref": "./examples/Namespaces/PrivateEndpointConnectionGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateLink" + ], + "summary": "Returns all Private Endpoint Connections that belong to the given Notification Hubs namespace.\r\nThis is a public API that can be called directly by Notification Hubs users.", + "operationId": "PrivateEndpointConnections_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResourceListResult" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "itemName": "value", + "nextLinkName": null + }, + "x-ms-examples": { + "PrivateEndpointConnections_List": { + "$ref": "./examples/Namespaces/PrivateEndpointConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources/{subResourceName}": { + "get": { + "tags": [ + "PrivateLink" + ], + "summary": "Returns Group Id response. \r\nThis is a public API required by the Networking RP contract. It can be used directly by Notification Hubs users.", + "description": "Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called.\r\nThat's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.", + "operationId": "PrivateEndpointConnections_GetGroupId", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "in": "path", + "name": "subResourceName", + "description": "Name of the Private Link sub-resource. The only supported sub-resource is \"namespace\"", + "required": true, + "type": "string", + "pattern": "^namespace$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_GetGroupId": { + "$ref": "./examples/Namespaces/PrivateLinkResourceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLink" + ], + "summary": "Returns all Group Ids supported by the Notification Hubs RP.\r\nThis is a public API required by the Networking RP contract. It can be used directly by Notification Hubs users.", + "description": "Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called.\r\nThat's why we don't send it to the sibling RP, but process it directly in the scale unit that received the request.", + "operationId": "PrivateEndpointConnections_ListGroupIds", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error code with reason.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "itemName": "value", + "nextLinkName": null + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListGroupIds": { + "$ref": "./examples/Namespaces/PrivateLinkResourceList.json" + } + } + } + } + }, + "definitions": { + "AccessRights": { + "description": "Defines values for AccessRights.", + "enum": [ + "Manage", + "Send", + "Listen" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": true + } + }, + "AdmCredential": { + "description": "Description of a NotificationHub AdmCredential.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AdmCredentialProperties" + } + }, + "x-ms-secret": true + }, + "AdmCredentialProperties": { + "description": "Description of a NotificationHub AdmCredential.", + "required": [ + "authTokenUrl", + "clientId", + "clientSecret" + ], + "type": "object", + "properties": { + "clientId": { + "description": "Gets or sets the client identifier.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "clientSecret": { + "description": "Gets or sets the credential secret access key.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "authTokenUrl": { + "description": "Gets or sets the URL of the authorization token.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + } + } + }, + "ApnsCredential": { + "description": "Description of a NotificationHub ApnsCredential.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ApnsCredentialProperties" + } + }, + "x-ms-secret": true + }, + "ApnsCredentialProperties": { + "description": "Description of a NotificationHub ApnsCredential.", + "required": [ + "endpoint" + ], + "type": "object", + "properties": { + "apnsCertificate": { + "description": "Gets or sets the APNS certificate.", + "type": "string", + "x-ms-secret": true + }, + "certificateKey": { + "description": "Gets or sets the certificate key.", + "type": "string", + "x-ms-secret": true + }, + "endpoint": { + "description": "Gets or sets the endpoint of this credential.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "thumbprint": { + "description": "Gets or sets the APNS certificate Thumbprint", + "type": "string", + "x-ms-secret": true + }, + "keyId": { + "description": "Gets or sets a 10-character key identifier (kid) key, obtained from\r\nyour developer account", + "type": "string", + "x-ms-secret": true + }, + "appName": { + "description": "Gets or sets the name of the application", + "type": "string", + "x-ms-secret": true + }, + "appId": { + "description": "Gets or sets the issuer (iss) registered claim key, whose value is\r\nyour 10-character Team ID, obtained from your developer account", + "type": "string", + "x-ms-secret": true + }, + "token": { + "description": "Gets or sets provider Authentication Token, obtained through your\r\ndeveloper account", + "type": "string", + "x-ms-secret": true + } + } + }, + "Availability": { + "description": "Represents metric availability (part of RP operation descriptions).", + "type": "object", + "properties": { + "timeGrain": { + "description": "Time grain of the availability.", + "type": "string", + "readOnly": true + }, + "blobDuration": { + "description": "Duration of the availability blob.", + "type": "string", + "readOnly": true + } + } + }, + "BaiduCredential": { + "description": "Description of a NotificationHub BaiduCredential.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/BaiduCredentialProperties" + } + }, + "x-ms-secret": true + }, + "BaiduCredentialProperties": { + "description": "Description of a NotificationHub BaiduCredential.", + "required": [ + "baiduApiKey", + "baiduEndPoint", + "baiduSecretKey" + ], + "type": "object", + "properties": { + "baiduApiKey": { + "description": "Gets or sets baidu Api Key.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "baiduEndPoint": { + "description": "Gets or sets baidu Endpoint.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "baiduSecretKey": { + "description": "Gets or sets baidu Secret Key", + "minLength": 1, + "type": "string", + "x-ms-secret": true + } + } + }, + "BrowserCredential": { + "description": "Description of a NotificationHub BrowserCredential.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/BrowserCredentialProperties" + } + }, + "x-ms-secret": true + }, + "BrowserCredentialProperties": { + "description": "Description of a NotificationHub BrowserCredential.", + "required": [ + "subject", + "vapidPrivateKey", + "vapidPublicKey" + ], + "type": "object", + "properties": { + "subject": { + "description": "Gets or sets web push subject.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "vapidPrivateKey": { + "description": "Gets or sets VAPID private key.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "vapidPublicKey": { + "description": "Gets or sets VAPID public key.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + } + } + }, + "CheckAvailabilityParameters": { + "description": "Parameters supplied to the Check Name Availability for Namespace and\r\nNotificationHubs.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "id": { + "description": "Gets resource Id", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Gets or sets resource name", + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Gets resource type", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Gets or sets resource location", + "type": "string" + }, + "tags": { + "description": "Gets or sets resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "isAvailiable": { + "description": "Not used and deprecated since API version 2023-01-01-preview", + "type": "boolean" + }, + "sku": { + "$ref": "#/definitions/Sku" + } + } + }, + "CheckAvailabilityResult": { + "description": "Description of a CheckAvailability resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "isAvailiable": { + "description": "Gets or sets true if the name is available and can be used to\r\ncreate new Namespace/NotificationHub. Otherwise false.", + "type": "boolean" + }, + "location": { + "description": "Deprecated - only for compatibility.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "description": "Deprecated - only for compatibility.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku" + } + } + }, + "ConnectionDetails": { + "description": "Part of Private Endpoint description that stores information about a connection between Private Endpoint and Notification Hubs namespace.\r\nThis is internal class, not visible to customers, and we use it only to discover the link identifier.", + "type": "object", + "properties": { + "id": { + "description": "A unique ID of the connection. This is not the ARM id, but rather an internal identifier set by the Networking RP. Notification Hubs code\r\ndoes not analyze it.", + "type": "string", + "readOnly": true + }, + "privateIpAddress": { + "description": "IP address of the Private Endpoint. This is not used by Notification Hubs.", + "type": "string", + "readOnly": true + }, + "linkIdentifier": { + "description": "Link identifier. This is a string representation of an integer that is also encoded in every IPv6 frame received by Front Door,\r\nand we use it to create implicit authorization rule that allows connection from the associated Private Endpoint.", + "type": "string", + "readOnly": true + }, + "groupId": { + "description": "Group name. Always \"namespace\" for Notification Hubs.", + "type": "string", + "readOnly": true + }, + "memberName": { + "description": "Member name. Always \"namespace\" for Notification Hubs.", + "type": "string", + "readOnly": true + } + } + }, + "DebugSendResponse": { + "description": "Description of a NotificationHub Resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DebugSendResult" + }, + "location": { + "description": "Deprecated - only for compatibility.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "description": "Deprecated - only for compatibility.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DebugSendResult": { + "description": "Result of DebugSend operations.", + "type": "object", + "properties": { + "success": { + "format": "int64", + "description": "Gets or sets successful send", + "type": "integer", + "readOnly": true + }, + "failure": { + "format": "int64", + "description": "Gets or sets send failure", + "type": "integer", + "readOnly": true + }, + "results": { + "description": "Gets or sets actual failure description", + "type": "array", + "items": { + "$ref": "#/definitions/RegistrationResult" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "FcmV1Credential": { + "description": "Description of a NotificationHub FcmV1Credential.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FcmV1CredentialProperties" + } + }, + "x-ms-secret": true + }, + "FcmV1CredentialProperties": { + "description": "Description of a NotificationHub FcmV1Credential.", + "required": [ + "clientEmail", + "privateKey", + "projectId" + ], + "type": "object", + "properties": { + "clientEmail": { + "description": "Gets or sets client email.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "privateKey": { + "description": "Gets or sets private key.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "projectId": { + "description": "Gets or sets project id.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + } + } + }, + "GcmCredential": { + "description": "Description of a NotificationHub GcmCredential.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/GcmCredentialProperties" + } + }, + "x-ms-secret": true + }, + "GcmCredentialProperties": { + "description": "Description of a NotificationHub GcmCredential.", + "required": [ + "googleApiKey" + ], + "type": "object", + "properties": { + "gcmEndpoint": { + "description": "Gets or sets the GCM endpoint.", + "type": "string", + "x-ms-secret": true + }, + "googleApiKey": { + "description": "Gets or sets the Google API key.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + } + } + }, + "GroupConnectivityInformation": { + "description": "Represents a connectivity information to Notification Hubs namespace. This is part of PrivateLinkService proxy that tell\r\nthe Networking RP how to connect to the Notification Hubs namespace.", + "type": "object", + "properties": { + "groupId": { + "description": "Group id. Always set to \"namespace\".", + "type": "string", + "readOnly": true + }, + "memberName": { + "description": "Member name. Always set to \"namespace\".", + "type": "string", + "readOnly": true + }, + "customerVisibleFqdns": { + "description": "List of customer-visible domain names that point to a Notification Hubs namespace.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "internalFqdn": { + "description": "One of the domain name from the customer-visible names; this is used internally by Private Link service to make connection to Notification Hubs\r\nnamespace.", + "type": "string", + "readOnly": true + }, + "redirectMapId": { + "description": "Not used by Notification Hubs.", + "type": "string", + "readOnly": true + }, + "privateLinkServiceArmRegion": { + "description": "ARM region for Private Link Service. We use the region that contains the connected Notification Hubs namespace.", + "type": "string", + "readOnly": true + } + } + }, + "IpRule": { + "description": "A network authorization rule that filters traffic based on IP address.", + "required": [ + "ipMask", + "rights" + ], + "type": "object", + "properties": { + "ipMask": { + "description": "IP mask.", + "minLength": 1, + "type": "string" + }, + "rights": { + "description": "List of access rights.", + "type": "array", + "items": { + "$ref": "#/definitions/AccessRights" + } + } + } + }, + "LogSpecification": { + "description": "A single log category specification.", + "type": "object", + "properties": { + "name": { + "description": "Name of the log category.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "Display name of the log category.", + "type": "string", + "readOnly": true + }, + "blobDuration": { + "description": "Duration of data written to a single blob.", + "type": "string", + "readOnly": true + }, + "categoryGroups": { + "description": "Category group for the log specification.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MetricSpecification": { + "description": "A metric specification.", + "type": "object", + "properties": { + "name": { + "description": "Metric name / id.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "User-visible metric name.", + "type": "string", + "readOnly": true + }, + "displayDescription": { + "description": "Description of the metric.", + "type": "string", + "readOnly": true + }, + "unit": { + "description": "Metric unit.", + "type": "string", + "readOnly": true + }, + "aggregationType": { + "description": "Type of the aggregation (Average, Minimum, Maximum, Total or Count).", + "type": "string", + "readOnly": true + }, + "availabilities": { + "description": "List of availabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/Availability" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "supportedTimeGrainTypes": { + "description": "List of supported time grain types.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "metricFilterPattern": { + "description": "The matching regex pattern to be applied to the field pointed by the \"metricsFilterPathSelector\" flag in the ARM manifest.", + "type": "string", + "readOnly": true + }, + "fillGapWithZero": { + "description": "Optional property. If set to true, then zero will be returned for time duration where no metric is emitted / published.", + "type": "boolean", + "readOnly": true + } + } + }, + "MpnsCredential": { + "description": "Description of a NotificationHub MpnsCredential.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MpnsCredentialProperties" + } + }, + "x-ms-secret": true + }, + "MpnsCredentialProperties": { + "description": "Description of a NotificationHub MpnsCredential.", + "required": [ + "certificateKey", + "mpnsCertificate", + "thumbprint" + ], + "type": "object", + "properties": { + "mpnsCertificate": { + "description": "Gets or sets the MPNS certificate.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "certificateKey": { + "description": "Gets or sets the certificate key for this credential.", + "minLength": 1, + "type": "string", + "x-ms-secret": true + }, + "thumbprint": { + "description": "Gets or sets the MPNS certificate Thumbprint", + "minLength": 1, + "type": "string", + "x-ms-secret": true + } + } + }, + "NamespaceListResult": { + "description": "The response of the List Namespace operation.", + "type": "object", + "properties": { + "value": { + "description": "Gets or sets result of the List AuthorizationRules operation.", + "type": "array", + "items": { + "$ref": "#/definitions/NamespaceResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Gets or sets link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "NamespacePatchParameters": { + "description": "Patch parameter for NamespaceResource.", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku" + }, + "properties": { + "$ref": "#/definitions/NamespaceProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NamespaceProperties": { + "description": "Represents namespace properties.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Notification Hubs namespace. This is immutable property, set automatically \r\nby the service when the namespace is created.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/OperationProvisioningState" + }, + "status": { + "$ref": "#/definitions/NamespaceStatus" + }, + "enabled": { + "description": "Gets or sets whether or not the namespace is currently enabled.", + "type": "boolean", + "readOnly": true + }, + "critical": { + "description": "Gets or sets whether or not the namespace is set as Critical.", + "type": "boolean", + "readOnly": true + }, + "subscriptionId": { + "description": "Namespace subscription id.", + "type": "string", + "readOnly": true + }, + "region": { + "description": "Region. The value is always set to the same value as Namespace.Location, so we are deprecating\r\nthis property.", + "type": "string", + "readOnly": true + }, + "metricId": { + "description": "Azure Insights Metrics id.", + "type": "string", + "readOnly": true + }, + "createdAt": { + "format": "date-time", + "description": "Time when the namespace was created.", + "type": "string", + "readOnly": true + }, + "updatedAt": { + "format": "date-time", + "description": "Time when the namespace was updated.", + "type": "string", + "readOnly": true + }, + "namespaceType": { + "$ref": "#/definitions/NamespaceType" + }, + "replicationRegion": { + "$ref": "#/definitions/ReplicationRegion" + }, + "zoneRedundancy": { + "$ref": "#/definitions/ZoneRedundancyPreference" + }, + "networkAcls": { + "$ref": "#/definitions/NetworkAcls" + }, + "pnsCredentials": { + "$ref": "#/definitions/PnsCredentials" + }, + "serviceBusEndpoint": { + "description": "Gets or sets endpoint you can use to perform NotificationHub\r\noperations.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Private Endpoint Connections for namespace", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + }, + "readOnly": true + }, + "scaleUnit": { + "description": "Gets or sets scaleUnit where the namespace gets created", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dataCenter": { + "description": "Deprecated.", + "type": "string" + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess" + } + } + }, + "NamespaceResource": { + "description": "Notification Hubs Namespace Resource.", + "required": [ + "location", + "sku" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/Sku" + }, + "properties": { + "$ref": "#/definitions/NamespaceProperties" + } + } + }, + "NamespaceStatus": { + "description": "Namespace status.", + "enum": [ + "Created", + "Creating", + "Suspended", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "NamespaceStatus", + "modelAsString": true + } + }, + "NamespaceType": { + "description": "Defines values for NamespaceType.", + "enum": [ + "Messaging", + "NotificationHub" + ], + "type": "string", + "x-ms-enum": { + "name": "NamespaceType", + "modelAsString": true + } + }, + "NetworkAcls": { + "description": "A collection of network authorization rules.", + "type": "object", + "properties": { + "ipRules": { + "description": "List of IP rules.", + "type": "array", + "items": { + "$ref": "#/definitions/IpRule" + }, + "x-ms-identifiers": [] + }, + "publicNetworkRule": { + "$ref": "#/definitions/PublicInternetAuthorizationRule" + } + } + }, + "NotificationHubListResult": { + "description": "The response of the List NotificationHub operation.", + "type": "object", + "properties": { + "value": { + "description": "Gets or sets result of the List AuthorizationRules operation.", + "type": "array", + "items": { + "$ref": "#/definitions/NotificationHubResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Gets or sets link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "NotificationHubPatchParameters": { + "description": "Patch parameter for NamespaceResource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/NotificationHubProperties" + }, + "sku": { + "$ref": "#/definitions/Sku" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NotificationHubProperties": { + "description": "NotificationHub properties.", + "type": "object", + "properties": { + "name": { + "description": "Gets or sets the NotificationHub name.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "registrationTtl": { + "description": "Gets or sets the RegistrationTtl of the created NotificationHub", + "type": "string" + }, + "authorizationRules": { + "description": "Gets or sets the AuthorizationRules of the created NotificationHub", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" + }, + "readOnly": true, + "x-ms-secret": true, + "x-ms-identifiers": [ + "keyName" + ] + }, + "apnsCredential": { + "$ref": "#/definitions/ApnsCredential" + }, + "wnsCredential": { + "$ref": "#/definitions/WnsCredential" + }, + "gcmCredential": { + "$ref": "#/definitions/GcmCredential" + }, + "mpnsCredential": { + "$ref": "#/definitions/MpnsCredential" + }, + "admCredential": { + "$ref": "#/definitions/AdmCredential" + }, + "baiduCredential": { + "$ref": "#/definitions/BaiduCredential" + }, + "browserCredential": { + "$ref": "#/definitions/BrowserCredential" + }, + "xiaomiCredential": { + "$ref": "#/definitions/XiaomiCredential" + }, + "fcmV1Credential": { + "$ref": "#/definitions/FcmV1Credential" + }, + "dailyMaxActiveDevices": { + "format": "int64", + "type": "integer", + "readOnly": true + } + } + }, + "NotificationHubResource": { + "description": "Notification Hub Resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NotificationHubProperties" + }, + "sku": { + "$ref": "#/definitions/Sku" + } + } + }, + "Operation": { + "description": "A NotificationHubs REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Gets operation name: {provider}/{resource}/{operation}", + "type": "string", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "properties": { + "$ref": "#/definitions/OperationProperties" + }, + "isDataAction": { + "description": "Gets or sets IsDataAction property. It is used to differentiate management and data plane operations.", + "type": "boolean", + "readOnly": true + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Gets service provider: Microsoft.NotificationHubs", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Gets resource on which the operation is performed: Invoice, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Gets operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Human-friendly operation description.", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "Result of the request to list NotificationHubs operations. It contains\r\na list of operations and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "Gets list of NotificationHubs operations supported by the\r\nMicrosoft.NotificationHubs resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "Gets URL to get the next set of operation list results if there are\r\nany.", + "type": "string", + "readOnly": true + } + } + }, + "OperationProperties": { + "description": "Optional operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "OperationProvisioningState": { + "description": "Defines values for OperationProvisioningState.", + "enum": [ + "Unknown", + "InProgress", + "Succeeded", + "Failed", + "Canceled", + "Pending", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationProvisioningState", + "modelAsString": true + } + }, + "PnsCredentials": { + "description": "Collection of Notification Hub or Notification Hub Namespace PNS credentials.", + "type": "object", + "properties": { + "admCredential": { + "$ref": "#/definitions/AdmCredential" + }, + "apnsCredential": { + "$ref": "#/definitions/ApnsCredential" + }, + "baiduCredential": { + "$ref": "#/definitions/BaiduCredential" + }, + "browserCredential": { + "$ref": "#/definitions/BrowserCredential" + }, + "gcmCredential": { + "$ref": "#/definitions/GcmCredential" + }, + "mpnsCredential": { + "$ref": "#/definitions/MpnsCredential" + }, + "wnsCredential": { + "$ref": "#/definitions/WnsCredential" + }, + "xiaomiCredential": { + "$ref": "#/definitions/XiaomiCredential" + }, + "fcmV1Credential": { + "$ref": "#/definitions/FcmV1Credential" + } + }, + "x-ms-secret": true + }, + "PnsCredentialsResource": { + "description": "Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs\r\nPNS credentials.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PnsCredentials" + }, + "location": { + "description": "Deprecated - only for compatibility.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "description": "Deprecated - only for compatibility.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PolicyKeyResource": { + "description": "Namespace / NotificationHub Regenerate Keys request.", + "required": [ + "policyKey" + ], + "type": "object", + "properties": { + "policyKey": { + "$ref": "#/definitions/PolicyKeyType" + } + } + }, + "PolicyKeyType": { + "description": "Type of Shared Access Policy Key (primary or secondary).", + "enum": [ + "PrimaryKey", + "SecondaryKey" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyKeyType", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private Endpoint Connection properties.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState" + }, + "privateEndpoint": { + "$ref": "#/definitions/RemotePrivateEndpointConnection" + }, + "groupIds": { + "description": "List of group ids. For Notification Hubs, it always contains a single \"namespace\" element.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/RemotePrivateLinkServiceConnectionState" + } + } + }, + "PrivateEndpointConnectionProvisioningState": { + "description": "State of Private Endpoint Connection.", + "enum": [ + "Unknown", + "Succeeded", + "Creating", + "Updating", + "UpdatingByProxy", + "Deleting", + "DeletingByProxy", + "Deleted" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateEndpointConnectionResource": { + "description": "Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + } + }, + "PrivateEndpointConnectionResourceListResult": { + "description": "The response of the List Private Endpoint Connections operation.", + "type": "object", + "properties": { + "value": { + "description": "Gets or sets result of the List AuthorizationRules operation.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Gets or sets link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateLinkConnectionStatus": { + "description": "State of Private Link Connection.", + "enum": [ + "Disconnected", + "Pending", + "Approved", + "Rejected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkConnectionStatus", + "modelAsString": true + } + }, + "PrivateLinkResource": { + "description": "A Private Link Arm Resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties" + } + } + }, + "PrivateLinkResourceListResult": { + "description": "The response of the List Private Link Resources operation.", + "type": "object", + "properties": { + "value": { + "description": "Gets or sets result of the List AuthorizationRules operation.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Gets or sets link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Represents properties of Private Link Resource.", + "type": "object", + "properties": { + "groupId": { + "description": "A Group Id for Private Link. For Notification Hubs, it is always set to \"namespace\".", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "Required members. For Notification Hubs, it's always a collection with a single \"namespace\" item.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "description": "Required DNS zone names. For Notification Hubs, it contains two CNames for Service Bus and Notification Hubs zones.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PrivateLinkServiceConnection": { + "description": "A customer-visible sub-resource of Private Endpoint, which describe the connection between Private Endpoint and Notification Hubs namespace.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Private Link Service connection.", + "type": "string" + }, + "groupIds": { + "description": "List of group ids. Always contains a single element - \"namespace\" - for Notification Hub Namespace.", + "type": "array", + "items": { + "type": "string" + } + }, + "requestMessage": { + "description": "Request message provided by the user that created the connection. This is usually used when the connection requires manual approval.", + "type": "string" + } + } + }, + "PublicInternetAuthorizationRule": { + "description": "A default (public Internet) network authorization rule, which contains rights if no other network rule matches.", + "required": [ + "rights" + ], + "type": "object", + "properties": { + "rights": { + "description": "List of access rights.", + "type": "array", + "items": { + "$ref": "#/definitions/AccessRights" + } + } + } + }, + "PublicNetworkAccess": { + "description": "Type of public network access.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "RegistrationResult": { + "description": "Notification result for a single registration.", + "type": "object", + "properties": { + "applicationPlatform": { + "description": "PNS type.", + "type": "string", + "readOnly": true + }, + "pnsHandle": { + "description": "PNS handle.", + "type": "string", + "readOnly": true + }, + "registrationId": { + "description": "Registration id.", + "type": "string", + "readOnly": true + }, + "outcome": { + "description": "Notification outcome.", + "type": "string", + "readOnly": true + } + } + }, + "RemotePrivateEndpointConnection": { + "description": "Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.", + "type": "object", + "properties": { + "id": { + "description": "ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace.", + "type": "string", + "readOnly": true + } + } + }, + "RemotePrivateLinkServiceConnectionState": { + "description": "State of the Private Link Service connection.", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkConnectionStatus" + }, + "description": { + "description": "Human-friendly description.", + "type": "string", + "readOnly": true + }, + "actionsRequired": { + "description": "Human-friendly description of required actions.", + "type": "string", + "readOnly": true + } + } + }, + "ReplicationRegion": { + "description": "Allowed replication region", + "enum": [ + "Default", + "WestUs2", + "NorthEurope", + "AustraliaEast", + "BrazilSouth", + "SouthEastAsia", + "SouthAfricaNorth", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "ReplicationRegion", + "modelAsString": true + } + }, + "ResourceListKeys": { + "description": "Response for the POST request that returns Namespace or NotificationHub access keys (connection strings).", + "type": "object", + "properties": { + "primaryConnectionString": { + "description": "Gets or sets primaryConnectionString of the AuthorizationRule.", + "type": "string", + "readOnly": true, + "x-ms-secret": true + }, + "secondaryConnectionString": { + "description": "Gets or sets secondaryConnectionString of the created\r\nAuthorizationRule", + "type": "string", + "readOnly": true, + "x-ms-secret": true + }, + "primaryKey": { + "description": "Gets or sets primaryKey of the created AuthorizationRule.", + "type": "string", + "readOnly": true, + "x-ms-secret": true + }, + "secondaryKey": { + "description": "Gets or sets secondaryKey of the created AuthorizationRule", + "type": "string", + "readOnly": true, + "x-ms-secret": true + }, + "keyName": { + "description": "Gets or sets keyName of the created AuthorizationRule", + "type": "string", + "readOnly": true + } + } + }, + "ServiceSpecification": { + "description": "Optional service specification used in Operations API.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Log specifications.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "metricSpecifications": { + "description": "Metric specification.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name", + "unit" + ] + } + } + }, + "SharedAccessAuthorizationRuleListResult": { + "description": "The response of the List Namespace operation.", + "type": "object", + "properties": { + "value": { + "description": "Gets or sets result of the List AuthorizationRules operation.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Gets or sets link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "SharedAccessAuthorizationRuleProperties": { + "description": "SharedAccessAuthorizationRule properties.", + "required": [ + "rights" + ], + "type": "object", + "properties": { + "rights": { + "description": "Gets or sets the rights associated with the rule.", + "type": "array", + "items": { + "$ref": "#/definitions/AccessRights" + } + }, + "primaryKey": { + "description": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token.", + "type": "string", + "x-ms-secret": true + }, + "secondaryKey": { + "description": "Gets a base64-encoded 256-bit primary key for signing and\r\nvalidating the SAS token.", + "type": "string", + "x-ms-secret": true + }, + "keyName": { + "description": "Gets a string that describes the authorization rule.", + "type": "string", + "readOnly": true + }, + "modifiedTime": { + "format": "date-time", + "description": "Gets the last modified time for this rule", + "type": "string", + "readOnly": true + }, + "createdTime": { + "format": "date-time", + "description": "Gets the created time for this rule", + "type": "string", + "readOnly": true + }, + "claimType": { + "description": "Gets a string that describes the claim type", + "type": "string", + "readOnly": true + }, + "claimValue": { + "description": "Gets a string that describes the claim value", + "type": "string", + "readOnly": true + }, + "revision": { + "format": "int32", + "description": "Gets the revision number for the rule", + "type": "integer", + "readOnly": true + } + } + }, + "SharedAccessAuthorizationRuleResource": { + "description": "Response for POST requests that return single SharedAccessAuthorizationRule.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties" + }, + "location": { + "description": "Deprecated - only for compatibility.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "description": "Deprecated - only for compatibility.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Sku": { + "description": "The Sku description for a namespace", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "$ref": "#/definitions/SkuName" + }, + "tier": { + "description": "Gets or sets the tier of particular sku", + "type": "string" + }, + "size": { + "description": "Gets or sets the Sku size", + "type": "string" + }, + "family": { + "description": "Gets or sets the Sku Family", + "type": "string" + }, + "capacity": { + "format": "int32", + "description": "Gets or sets the capacity of the resource", + "type": "integer" + } + } + }, + "SkuName": { + "description": "Namespace SKU name.", + "enum": [ + "Free", + "Basic", + "Standard" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "WnsCredential": { + "description": "Description of a NotificationHub WnsCredential.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/WnsCredentialProperties" + } + }, + "x-ms-secret": true + }, + "WnsCredentialProperties": { + "description": "Description of a NotificationHub WnsCredential.", + "type": "object", + "properties": { + "packageSid": { + "description": "Gets or sets the package ID for this credential.", + "type": "string", + "x-ms-secret": true + }, + "secretKey": { + "description": "Gets or sets the secret key.", + "type": "string", + "x-ms-secret": true + }, + "windowsLiveEndpoint": { + "description": "Gets or sets the Windows Live endpoint.", + "type": "string", + "x-ms-secret": true + }, + "certificateKey": { + "description": "Ges or sets the WNS Certificate Key.", + "type": "string", + "x-ms-secret": true + }, + "wnsCertificate": { + "description": "Gets or sets the WNS Certificate.", + "type": "string", + "x-ms-secret": true + } + } + }, + "XiaomiCredential": { + "description": "Description of a NotificationHub XiaomiCredential.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/XiaomiCredentialProperties" + } + }, + "x-ms-secret": true + }, + "XiaomiCredentialProperties": { + "description": "Description of a NotificationHub XiaomiCredentialProperties.", + "type": "object", + "properties": { + "appSecret": { + "description": "Gets or sets app secret.", + "type": "string", + "x-ms-secret": true + }, + "endpoint": { + "description": "Gets or sets xiaomi service endpoint.", + "type": "string", + "x-ms-secret": true + } + } + }, + "ZoneRedundancyPreference": { + "description": "Namespace SKU name.", + "default": "Disabled", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ZoneRedundancyPreference", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "parameters": { + "NamespaceName": { + "in": "path", + "name": "namespaceName", + "description": "Namespace name", + "required": true, + "maxLength": 50, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "HubName": { + "in": "path", + "name": "notificationHubName", + "description": "Notification Hub name", + "required": true, + "maxLength": 265, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9-./_]*$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "AuthorizationRuleName": { + "in": "path", + "name": "authorizationRuleName", + "description": "Authorization Rule Name", + "required": true, + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9!()*-._]+$", + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionName": { + "in": "path", + "name": "privateEndpointConnectionName", + "description": "Private Endpoint Connection Name", + "required": true, + "maxLength": 87, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9-]*\\.[a-fA-F0-9\\-]+$", + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/notificationhubs/resource-manager/readme.md b/specification/notificationhubs/resource-manager/readme.md index 4519aa007016..dde81671012f 100644 --- a/specification/notificationhubs/resource-manager/readme.md +++ b/specification/notificationhubs/resource-manager/readme.md @@ -42,7 +42,7 @@ suppress: ``` yaml openapi-type: arm -tag: package-2023-09 +tag: package-preview-2023-10 directive: - where: - $.definitions.NamespaceCreateOrUpdateParameters @@ -52,14 +52,23 @@ directive: ``` +### Tag: package-preview-2023-10 + +These settings apply only when `--tag=package-preview-2023-10` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-10' +input-file: + - Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json +``` ### Tag: package-2023-09 These settings apply only when `--tag=package-2023-09` is specified on the command line. -```yaml $(tag) == 'package-2023-09' +``` yaml $(tag) == 'package-2023-09' input-file: - Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json ``` + ### Tag: package-preview-2023-01 These settings apply only when `--tag=package-preview-2023-01` is specified on the command line. diff --git a/specification/paloaltonetworks/resource-manager/readme.go.md b/specification/paloaltonetworks/resource-manager/readme.go.md index bcd98267126f..52f559885df7 100644 --- a/specification/paloaltonetworks/resource-manager/readme.go.md +++ b/specification/paloaltonetworks/resource-manager/readme.go.md @@ -8,4 +8,11 @@ module-name: sdk/resourcemanager/paloaltonetworksngfw/armpanngfw module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true +directive: + - where-operation: LocalRulestacks_listAppIds + transform: delete $['x-ms-pageable']; + - where-operation: LocalRulestacks_listCountries + transform: delete $['x-ms-pageable']; + - where-operation: LocalRulestacks_listPredefinedUrlCategories + transform: delete $['x-ms-pageable']; ``` diff --git a/specification/paloaltonetworks/resource-manager/readme.typescript.md b/specification/paloaltonetworks/resource-manager/readme.typescript.md index 4b540d5c4d93..4e688652fe47 100644 --- a/specification/paloaltonetworks/resource-manager/readme.typescript.md +++ b/specification/paloaltonetworks/resource-manager/readme.typescript.md @@ -10,4 +10,18 @@ typescript: output-folder: "$(typescript-sdks-folder)/sdk/paloaltonetworksngfw/arm-paloaltonetworksngfw" payload-flattening-threshold: 1 generate-metadata: true + +directive: + - from: PaloAltoNetworks.Cloudngfw.json + where: $.paths + transform: > + for (const pathKey in $) { + const path = $[pathKey]; + for (const methodKey in path) { + const method = path[methodKey]; + if (method['x-ms-pageable'] && (method['x-ms-pageable']['operationName'] === 'LocalRulestacks_listAppIds' || method['x-ms-pageable']['operationName'] === 'LocalRulestacks_listCountries' || method['x-ms-pageable']['operationName'] === 'LocalRulestacks_listPredefinedUrlCategories')) { + delete method['x-ms-pageable']; + } + } + } ``` diff --git a/specification/playwrighttesting/resource-manager/readme.java.md b/specification/playwrighttesting/resource-manager/readme.java.md index 0de1e63db4c5..6b5903a1b8dc 100644 --- a/specification/playwrighttesting/resource-manager/readme.java.md +++ b/specification/playwrighttesting/resource-manager/readme.java.md @@ -5,4 +5,5 @@ These settings apply only when `--java` is specified on the command line. ```yaml $(java) title: PlaywrightTestingMgmtClient service-name: Playwright Testing +client-flattened-annotation-target: disabled ``` diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/ThreatProtection.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/ThreatProtection.json index 14d6408e7d39..439622eb9ea7 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/ThreatProtection.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/ThreatProtection.json @@ -173,6 +173,14 @@ "schema": { "$ref": "#/definitions/ServerThreatProtectionSettingsModel" } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } } }, "x-ms-long-running-operation": true, @@ -181,7 +189,7 @@ }, "x-ms-examples": { "Update a server's Threat Protection settings": { - "$ref": "./examples/ServerThreatProtectionSettingsCreate.json" + "$ref": "./examples/ServerThreatProtectionSettingsCreateOrUpdate.json" } } } diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/examples/ServerThreatProtectionSettingsCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/examples/ServerThreatProtectionSettingsCreate.json deleted file mode 100644 index 3af19675c7a9..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/examples/ServerThreatProtectionSettingsCreate.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "threatprotection-4799", - "serverName": "threatprotection-6440", - "threatProtectionName": "Default", - "api-version": "2023-06-01-preview", - "parameters": { - "properties": { - "state": "Enabled" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", - "name": "Default", - "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", - "properties": { - "state": "Enabled", - "creationTime": "2023-09-03T04:41:33.937Z" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", - "name": "Default", - "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", - "properties": { - "state": "Enabled", - "creationTime": "2023-09-03T04:41:33.937Z" - } - } - } - } -} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/examples/ServerThreatProtectionSettingsCreateOrUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/examples/ServerThreatProtectionSettingsCreateOrUpdate.json new file mode 100644 index 000000000000..082fd33892e1 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/examples/ServerThreatProtectionSettingsCreateOrUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-4799", + "serverName": "threatprotection-6440", + "threatProtectionName": "Default", + "api-version": "2023-06-01-preview", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", + "properties": { + "state": "Enabled", + "creationTime": "2023-09-03T04:41:33.937Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", + "properties": { + "state": "Enabled", + "creationTime": "2023-09-03T04:41:33.937Z" + } + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index 610b6d9f9c7b..f2fd4fe4d987 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -74,6 +74,9 @@ suppressions: - code: ProvisioningStateSpecifiedForLROPut from: ThreatProtection.json reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: PutResponseCodes + from: ThreatProtection.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. - code: ProvisioningStateSpecifiedForLROPut from: VirtualEndpoints.json reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-06-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-06-01/bms.json index 76a55d9ad50e..85289e910d5e 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-06-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2023-06-01/bms.json @@ -9663,17 +9663,34 @@ } } }, + "UserAssignedIdentityProperties": { + "type": "object", + "description": "User assigned managed identity properties", + "properties": { + "clientId": { + "description": "The client ID of the assigned identity.", + "type": "string" + }, + "principalId": { + "description": "The principal ID of the assigned identity.", + "type": "string" + } + } + }, "UserAssignedManagedIdentityDetails": { "type": "object", + "description": "User assigned managed identity details", "properties": { "identityArmId": { - "type": "string" + "type": "string", + "description": "The ARM id of the assigned identity." }, "identityName": { - "type": "string" + "type": "string", + "description": "The name of the assigned identity." }, "userAssignedIdentityProperties": { - "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/UserAssignedIdentity" + "$ref": "#/definitions/UserAssignedIdentityProperties" } } }, diff --git a/specification/riskiq/Easm/client.tsp b/specification/riskiq/Easm/client.tsp new file mode 100644 index 000000000000..04c7df029fc0 --- /dev/null +++ b/specification/riskiq/Easm/client.tsp @@ -0,0 +1,55 @@ +import "@azure-tools/typespec-client-generator-core"; +import "./main.tsp"; + +using Azure.ClientGenerator.Core; + +@TypeSpec.Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_2) +@TypeSpec.Versioning.useDependency(Easm.Versions.v2023_03_01_preview) +namespace Customizations; + +@client({ + name: "EasmClient", + service: Easm, +}) +interface EasmClient { + listAssetResource is Easm.Assets.listAssetResource; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + updateAssets is Easm.Assets.updateAssets; + getAssetResource is Easm.Assets.getAssetResource; + + listDataConnection is Easm.DataConnections.listDataConnection; + validateDataConnection is Easm.DataConnections.validateDataConnection; + getDataConnection is Easm.DataConnections.getDataConnection; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + createOrReplaceDataConnection is Easm.DataConnections.createOrReplaceDataConnection; + deleteDataConnection is Easm.DataConnections.deleteDataConnection; + + listDiscoGroup is Easm.DiscoveryGroups.listDiscoGroup; + validateDiscoGroup is Easm.DiscoveryGroups.validateDiscoGroup; + getDiscoGroup is Easm.DiscoveryGroups.getDiscoGroup; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + createOrReplaceDiscoGroup is Easm.DiscoveryGroups.createOrReplaceDiscoGroup; + runDiscoGroup is Easm.DiscoveryGroups.runDiscoGroup; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + listRuns is Easm.DiscoveryGroups.listRuns; + + listDiscoTemplate is Easm.DiscoveryTemplates.listDiscoTemplate; + getDiscoTemplate is Easm.DiscoveryTemplates.getDiscoTemplate; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + getBillable is Easm.Reports.getBillable; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + getSnapshot is Easm.Reports.getSnapshot; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + getSummary is Easm.Reports.getSummary; + + listSavedFilter is Easm.SavedFilters.listSavedFilter; + getSavedFilter is Easm.SavedFilters.getSavedFilter; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + createOrReplaceSavedFilter is Easm.SavedFilters.createOrReplaceSavedFilter; + deleteSavedFilter is Easm.SavedFilters.deleteSavedFilter; + + listTask is Easm.Tasks.listTask; + getTask is Easm.Tasks.getTask; + cancelTask is Easm.Tasks.cancelTask; +} diff --git a/specification/security/resource-manager/readme.go.md b/specification/security/resource-manager/readme.go.md index 401f81fedcf5..a3ac67dcee4f 100644 --- a/specification/security/resource-manager/readme.go.md +++ b/specification/security/resource-manager/readme.go.md @@ -25,6 +25,47 @@ directive: - rename-model: from: SecurityOperator to: OperatorResource +- from: externalSecuritySolutions.json + where: $.definitions['ExternalSecuritySolutionKind'] + transform: > + $ = { + "type": "string", + "description": "The kind of the external solution", + "enum": [ + "CEF", + "ATA", + "AAD" + ], + "x-ms-enum": { + "name": "ExternalSecuritySolutionKind", + "modelAsString": true, + "values": [ + { + "value": "CEF" + }, + { + "value": "ATA" + }, + { + "value": "AAD" + } + ] + } + }; +- from: externalSecuritySolutions.json + where: $.definitions['ExternalSecuritySolution'] + transform: > + $.properties['kind'] = { + "$ref": "#/definitions/ExternalSecuritySolutionKind" + }; + $.allOf = [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + }, + { + "$ref": "../../../common/v1/types.json#/definitions/Location" + } + ] ``` ### Common Go settings diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index f5a80130ad09..3f97a605f246 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -152,6 +152,15 @@ input-file: - Microsoft.Security/preview/2023-01-01-preview/securityOperators.json ``` +### Tag: package-preview-2023-02-15-only + +These settings apply only when `--tag=package-preview-2023-02-15-only` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2023-02-15-only' +input-file: + - Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json +``` + ### Tag: package-preview-2023-02-only These settings apply only when `--tag=package-preview-2023-02-only` is specified on the command line. @@ -627,6 +636,7 @@ These settings apply only when `--tag=package-2020-01-preview-python-only` is sp ``` yaml $(tag) == 'package-2020-01-preview-python-only' input-file: - Microsoft.Security/preview/2020-01-01-preview/connectors.json +- Microsoft.Security/preview/2020-01-01-preview/securityContacts.json # Needed when there is more than one input file override-info: diff --git a/specification/security/resource-manager/readme.python.md b/specification/security/resource-manager/readme.python.md index c6440dc024d6..222fc9002ac4 100644 --- a/specification/security/resource-manager/readme.python.md +++ b/specification/security/resource-manager/readme.python.md @@ -39,10 +39,17 @@ clear-output-folder: true default-api-version: "2023-01-01" multiapi: true batch: + - tag: package-2023-11-15 + - tag: package-preview-2023-10 + - tag: package-preview-2023-09 + - tag: package-2023-05 + - tag: package-preview-2023-05 - tag: package-preview-2023-03-only + - tag: package-preview-2023-02-15-only - tag: package-preview-2023-02-only - tag: package-preview-2023-01-only - tag: package-2023-01 + - tag: package-preview-2022-12 - tag: package-preview-2022-08 - tag: package-preview-2022-07 - tag: package-2022-05 @@ -57,7 +64,6 @@ batch: - tag: package-2021-06-only - tag: package-2021-05-preview-only - tag: package-2021-01-only - - tag: package-2021-01-preview-only - tag: package-2020-07-preview-only - tag: package-2020-01-python-only - tag: package-2020-01-preview-python-only @@ -74,6 +80,57 @@ batch: ``` yaml $(multiapiscript) output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/ perform-load: false +clear-output-folder: false +``` + +### Tag: package-2023-11-15 and python + +These settings apply only when `--tag=package-2023-11-15 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2023-11-15' && $(python) +namespace: azure.mgmt.security.v2023_11_15 +output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2023_11_15 +``` + +### Tag: package-preview-2023-10 and python + +These settings apply only when `--tag=package-preview-2023-10 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2023-10' && $(python) +namespace: azure.mgmt.security.v2023_10_01_preview +output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2023_10_01_preview +``` + +### Tag: package-preview-2023-09 and python + +These settings apply only when `--tag=package-preview-2023-09 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2023-09' && $(python) +namespace: azure.mgmt.security.v2023_09_01_preview +output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2023_09_01_preview +``` + +### Tag: package-2023-05 and python + +These settings apply only when `--tag=package-2023-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2023-05' && $(python) +namespace: azure.mgmt.security.v2023_05_01 +output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2023_05_01 +``` + +### Tag: package-preview-2023-05 and python + +These settings apply only when `--tag=package-preview-2023-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2023-05' && $(python) +namespace: azure.mgmt.security.v2023_05_01_preview +output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2023_05_01_preview ``` ### Tag: package-preview-2023-03-only and python @@ -86,6 +143,16 @@ namespace: azure.mgmt.security.v2023_03_01_preview output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2023_03_01_preview ``` +### Tag: package-preview-2023-02-15-only and python + +These settings apply only when `--tag=package-preview-2023-02-15-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2023-02-15-only' && $(python) +namespace: azure.mgmt.security.v2023_02_15_preview +output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2023_02_15_preview +``` + ### Tag: package-preview-2023-02-only and python These settings apply only when `--tag=package-preview-2023-02-only --python` is specified on the command line. @@ -106,6 +173,16 @@ namespace: azure.mgmt.security.v2023_01_01_preview output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2023_01_01_preview ``` +### Tag: package-preview-2022-12 and python + +These settings apply only when `--tag=package-preview-2022-12 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-preview-2022-12' && $(python) +namespace: azure.mgmt.security.v2022_12_01_preview +output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2022_12_01_preview +``` + ### Tag: package-preview-2022-08 and python These settings apply only when `--tag=package-preview-2022-08 --python` is specified on the command line. @@ -256,16 +333,6 @@ namespace: azure.mgmt.security.v2021_01_01 output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2021_01_01 ``` -### Tag: package-2021-01-preview-only and python - -These settings apply only when `--tag=package-2021-01-preview-only --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2021-01-preview-only' && $(python) -namespace: azure.mgmt.security.v2021_01_15_preview -output-folder: $(python-sdks-folder)/security/azure-mgmt-security/azure/mgmt/security/v2021_01_15_preview -``` - ### Tag: package-2020-07-preview-only and python These settings apply only when `--tag=package-2020-07-preview-only --python` is specified on the command line. diff --git a/specification/servicenetworking/resource-manager/readme.java.md b/specification/servicenetworking/resource-manager/readme.java.md new file mode 100644 index 000000000000..01cdabebe9ad --- /dev/null +++ b/specification/servicenetworking/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +``` diff --git a/specification/sphere/resource-manager/readme.java.md b/specification/sphere/resource-manager/readme.java.md index db639eef5007..01cdabebe9ad 100644 --- a/specification/sphere/resource-manager/readme.java.md +++ b/specification/sphere/resource-manager/readme.java.md @@ -1,33 +1,7 @@ ## Java These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.azuresphere -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-azuresphere +client-flattened-annotation-target: disabled ``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2022-09-01-preview -``` - -### Tag: package-2022-09-01-preview and java - -These settings apply only when `--tag=package-2022-09-01-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2022-09-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.azuresphere.v2022-09-01-preview - output-folder: $(azure-libraries-for-java-folder)/sdk/azuresphere/mgmt-v2022-09-01-preview -regenerate-manager: true -generate-interface: true -``` \ No newline at end of file diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/amlfilesystem.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/amlfilesystem.json new file mode 100644 index 000000000000..c0e33cec2898 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/amlfilesystem.json @@ -0,0 +1,1191 @@ +{ + "swagger": "2.0", + "info": { + "description": "Azure Managed Lustre provides a fully managed Lustre® file system, integrated with Blob storage, for use on demand. These operations create and manage Azure Managed Lustre file systems.", + "title": "Managed Lustre client", + "version": "2023-11-01-preview" + }, + "host": "management.azure.com", + "basePath": "/", + "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.StorageCache/amlFilesystems": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of AML file systems. Note that entity references might replace complete file system objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference", + "schema": { + "$ref": "#/definitions/AmlFilesystemsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "amlFilesystems_List": { + "$ref": "./examples/amlFilesystems_List.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Returns all AML file systems the user has access to under a subscription.", + "operationId": "amlFilesystems_List" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of AmlFilesystem objects. Note that entity references might replace complete AmlFilesystem objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference", + "schema": { + "$ref": "#/definitions/AmlFilesystemsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_ListByResourceGroup": { + "$ref": "./examples/amlFilesystems_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "amlFilesystems" + ], + "description": "Returns all AML file systems the user has access to under a resource group.", + "operationId": "amlFilesystems_ListByResourceGroup" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}": { + "delete": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "AML file system deleted." + }, + "202": { + "description": "Started the AML file system's transition to Deleted state. Poll the AML file system to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "AML file system deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_Delete": { + "$ref": "./examples/amlFilesystems_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "tags": [ + "amlFilesystems" + ], + "description": "Schedules an AML file system for deletion.", + "operationId": "amlFilesystems_Delete" + }, + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the AML file system object corresponding to amlFilesystemName.", + "schema": { + "$ref": "#/definitions/AmlFilesystem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_Get": { + "$ref": "./examples/amlFilesystems_Get.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Returns an AML file system.", + "operationId": "amlFilesystems_Get" + }, + "put": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + }, + { + "description": "Object containing the user-selectable properties of the AML file system. If read-only properties are included, they must match the existing values of those properties.", + "in": "body", + "name": "amlFilesystem", + "required": true, + "schema": { + "$ref": "#/definitions/AmlFilesystem" + } + } + ], + "responses": { + "200": { + "description": "The AML file system has been created or updated.", + "schema": { + "$ref": "#/definitions/AmlFilesystem" + } + }, + "201": { + "description": "AML file system creation has been initiated. Poll the AML file system's provisioningState property to monitor creation progress.", + "headers": { + "azure-async-operation": { + "description": "URI to poll for the operation status", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AmlFilesystem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_CreateOrUpdate": { + "$ref": "./examples/amlFilesystems_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "amlFilesystems" + ], + "description": "Create or update an AML file system.", + "operationId": "amlFilesystems_CreateOrUpdate" + }, + "patch": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + }, + { + "description": "Object containing the user-selectable properties of the AML file system. If read-only properties are included, they must match the existing values of those properties.", + "in": "body", + "name": "amlFilesystem", + "required": true, + "schema": { + "$ref": "#/definitions/AmlFilesystemUpdate" + } + } + ], + "responses": { + "200": { + "description": "Updated the AML file system.", + "schema": { + "$ref": "#/definitions/AmlFilesystem" + } + }, + "202": { + "description": "AML file system update has been initiated. Poll the AML file system's provisioningState property to monitor update progress.", + "headers": { + "Location": { + "description": "URI to poll for the operation status", + "type": "string" + }, + "azure-async-operation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_Update": { + "$ref": "./examples/amlFilesystems_Update.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "amlFilesystems" + ], + "description": "Update an AML file system instance.", + "operationId": "amlFilesystems_Update" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/archive": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + }, + { + "name": "archiveInfo", + "in": "body", + "description": "Information about the archive operation", + "schema": { + "$ref": "#/definitions/AmlFilesystemArchiveInfo" + } + } + ], + "responses": { + "200": { + "description": "AML file system has started the archive operation. Poll the AML file system's hsm.archiveStatus field to monitor the progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_Archive": { + "$ref": "./examples/amlFilesystems_Archive.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Archive data from the AML file system.", + "operationId": "amlFilesystems_Archive" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/cancelArchive": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + } + ], + "responses": { + "200": { + "description": "AML file system has started the cancellation of the archive operation. Poll the AML file system's hsm.archiveStatus field to monitor the progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_cancelArchive": { + "$ref": "./examples/amlFilesystems_CancelArchive.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Cancel archiving data from the AML file system.", + "operationId": "amlFilesystems_CancelArchive" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/checkAmlFSSubnets": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "amlFilesystemSubnetInfo", + "in": "body", + "description": "Information about the subnets to validate.", + "schema": { + "$ref": "#/definitions/AmlFilesystemSubnetInfo" + } + } + ], + "responses": { + "200": { + "description": "The subnets provided meet the requirements for AML file system create." + }, + "400": { + "description": "The subnets provided do not meet the requirements for AML file system create.", + "schema": { + "$ref": "#/definitions/AmlFilesystemCheckSubnetError" + }, + "x-ms-error-response": true + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "checkAmlFSSubnets": { + "$ref": "./examples/checkAmlFSSubnets.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Check that subnets will be valid for AML file system create calls.", + "operationId": "checkAmlFSSubnets" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/getRequiredAmlFSSubnetsSize": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "requiredAMLFilesystemSubnetsSizeInfo", + "in": "body", + "description": "Information to determine the number of available IPs a subnet will need to host the AML file system.", + "schema": { + "$ref": "#/definitions/RequiredAmlFilesystemSubnetsSizeInfo" + } + } + ], + "responses": { + "200": { + "description": "The number of available IP addresses a subnet will need for an AML file system.", + "schema": { + "$ref": "#/definitions/RequiredAmlFilesystemSubnetsSize" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "getRequiredAmlFilesystemSubnetsSize": { + "$ref": "./examples/getRequiredAmlFSSubnetsSize.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Get the number of available IP addresses needed for the AML file system information provided.", + "operationId": "getRequiredAmlFSSubnetsSize" + } + } + }, + "definitions": { + "AmlFilesystemIdentity": { + "type": "object", + "description": "Managed Identity properties.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID for the user-assigned identity of the resource." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID associated with the resource." + }, + "type": { + "type": "string", + "description": "The type of identity used for the resource.", + "enum": [ + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "AmlFilesystemIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "description": "A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary.", + "$ref": "#/definitions/UserAssignedIdentities" + } + } + }, + "AmlFilesystem": { + "description": "An AML file system instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md", + "x-ms-azure-resource": true, + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/AmlFilesystemIdentity", + "description": "The managed identity used by the AML file system, if configured." + }, + "sku": { + "description": "SKU for the resource.", + "$ref": "#/definitions/SkuName" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability zones for resources. This field should only contain a single element in the array.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the AML file system.", + "properties": { + "storageCapacityTiB": { + "description": "The size of the AML file system, in TiB. This might be rounded up.", + "x-ms-mutability": [ + "read", + "create" + ], + "type": "number", + "format": "float" + }, + "health": { + "description": "Health of the AML file system.", + "readOnly": true, + "$ref": "#/definitions/AmlFilesystemHealth" + }, + "provisioningState": { + "description": "ARM provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Creating", + "Deleting", + "Updating", + "Canceled" + ], + "x-ms-enum": { + "name": "AmlFilesystemProvisioningStateType", + "modelAsString": true + }, + "type": "string", + "readOnly": true + }, + "filesystemSubnet": { + "description": "Subnet used for managing the AML file system and for client-facing operations. This subnet should have at least a /24 subnet mask within the VNET's address space.", + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "storagecache.json#/definitions/URLString" + }, + "clientInfo": { + "$ref": "#/definitions/AmlFilesystemClientInfo", + "description": "Client information for the AML file system." + }, + "throughputProvisionedMBps": { + "type": "integer", + "format": "int32", + "description": "Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput", + "readOnly": true + }, + "encryptionSettings": { + "$ref": "#/definitions/AmlFilesystemEncryptionSettings", + "description": "Specifies encryption settings of the AML file system." + }, + "maintenanceWindow": { + "description": "Start time of a 30-minute weekly maintenance window.", + "type": "object", + "properties": { + "dayOfWeek": { + "type": "string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "MaintenanceDayOfWeekType", + "modelAsString": false + }, + "description": "Day of the week on which the maintenance window will occur." + }, + "timeOfDayUTC": { + "type": "string", + "pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$", + "description": "The time of day (in UTC) to start the maintenance window." + } + } + }, + "hsm": { + "type": "object", + "description": "Hydration and archive settings and status", + "properties": { + "settings": { + "$ref": "#/definitions/AmlFilesystemHsmSettings", + "description": "Specifies HSM settings of the AML file system." + }, + "archiveStatus": { + "type": "array", + "readOnly": true, + "description": "Archive status", + "items": { + "$ref": "#/definitions/AmlFilesystemArchive" + }, + "x-ms-identifiers": [ + "filesystemPath" + ] + } + } + }, + "rootSquashSettings": { + "$ref": "#/definitions/AmlFilesystemRootSquashSettings", + "description": "Specifies root squash settings of the AML file system." + } + }, + "type": "object", + "required": [ + "filesystemSubnet", + "storageCapacityTiB", + "maintenanceWindow" + ] + } + } + }, + "AmlFilesystemUpdate": { + "description": "An AML file system update instance.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "Properties of the AML file system.", + "properties": { + "encryptionSettings": { + "$ref": "#/definitions/AmlFilesystemEncryptionSettings", + "description": "Specifies encryption settings of the AML file system." + }, + "maintenanceWindow": { + "description": "Start time of a 30-minute weekly maintenance window.", + "type": "object", + "properties": { + "dayOfWeek": { + "type": "string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "MaintenanceDayOfWeekType", + "modelAsString": false + }, + "description": "Day of the week on which the maintenance window will occur." + }, + "timeOfDayUTC": { + "type": "string", + "pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$", + "description": "The time of day (in UTC) to start the maintenance window." + } + } + }, + "rootSquashSettings": { + "$ref": "#/definitions/AmlFilesystemRootSquashSettings", + "description": "Specifies root squash settings of the AML file system." + } + } + } + } + }, + "AmlFilesystemName": { + "readOnly": true, + "description": "Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.", + "type": "string", + "pattern": "^[0-9a-zA-Z][-0-9a-zA-Z_]{0,78}[0-9a-zA-Z]$", + "minLength": 2, + "maxLength": 80 + }, + "AmlFilesystemsListResult": { + "description": "Result of the request to list AML file systems. It contains a list of AML file systems and a URL link to get the next set of results.", + "properties": { + "nextLink": { + "description": "URL to get the next set of AML file system list results, if there are any.", + "type": "string" + }, + "value": { + "description": "List of AML file systems.", + "items": { + "$ref": "#/definitions/AmlFilesystem" + }, + "type": "array" + } + }, + "type": "object" + }, + "AmlFilesystemHealth": { + "description": "An indication of AML file system health. Gives more information about health than just that related to provisioning.", + "readOnly": true, + "properties": { + "state": { + "description": "List of AML file system health states.", + "enum": [ + "Unavailable", + "Available", + "Degraded", + "Transitioning", + "Maintenance" + ], + "x-ms-enum": { + "name": "AmlFilesystemHealthStateType", + "modelAsString": true + }, + "type": "string" + }, + "statusCode": { + "description": "Server-defined error code for the AML file system health", + "type": "string" + }, + "statusDescription": { + "description": "Describes the health state.", + "type": "string" + } + }, + "type": "object" + }, + "AmlFilesystemEncryptionSettings": { + "description": "AML file system encryption settings.", + "properties": { + "keyEncryptionKey": { + "$ref": "storagecache.json#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the encryption key in Key Vault." + } + }, + "type": "object" + }, + "AmlFilesystemHsmSettings": { + "description": "AML file system HSM settings.", + "x-ms-mutability": [ + "read", + "create" + ], + "type": "object", + "properties": { + "container": { + "description": "Resource ID of storage container used for hydrating the namespace and archiving from the namespace. The resource provider must have permission to create SAS tokens on the storage account.", + "$ref": "storagecache.json#/definitions/URLString" + }, + "loggingContainer": { + "description": "Resource ID of storage container used for logging events and errors. Must be a separate container in the same storage account as the hydration and archive container. The resource provider must have permission to create SAS tokens on the storage account.", + "$ref": "storagecache.json#/definitions/URLString" + }, + "importPrefix": { + "description": "Only blobs in the non-logging container that start with this path/prefix get hydrated into the cluster namespace.", + "type": "string", + "default": "/" + } + }, + "required": [ + "container", + "loggingContainer" + ] + }, + "AmlFilesystemRootSquashSettings": { + "description": "AML file system squash settings.", + "properties": { + "mode": { + "type": "string", + "description": "Squash mode of the AML file system. 'All': User and Group IDs on files will be squashed to the provided values for all users on non-trusted systems. 'RootOnly': User and Group IDs on files will be squashed to provided values for solely the root user on non-trusted systems. 'None': No squashing of User and Group IDs is performed for any users on any systems.", + "enum": [ + "None", + "RootOnly", + "All" + ], + "x-ms-enum": { + "name": "AmlFilesystemSquashMode", + "modelAsString": true + } + }, + "noSquashNidLists": { + "description": "Semicolon separated NID IP Address list(s) to be added to the TrustedSystems.", + "type": "string" + }, + "squashUID": { + "type": "integer", + "description": "User ID to squash to.", + "format": "int64" + }, + "squashGID": { + "type": "integer", + "description": "Group ID to squash to.", + "format": "int64" + }, + "status": { + "readOnly": true, + "type": "string", + "description": "AML file system squash status." + } + }, + "type": "object" + }, + "AmlFilesystemClientInfo": { + "type": "object", + "description": "AML file system client information", + "readOnly": true, + "properties": { + "mgsAddress": { + "description": "The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS).", + "readOnly": true, + "type": "string" + }, + "mountCommand": { + "description": "Recommended command to mount the AML file system", + "readOnly": true, + "type": "string" + }, + "lustreVersion": { + "type": "string", + "description": "The version of Lustre running in the AML file system", + "readOnly": true + }, + "containerStorageInterface": { + "$ref": "#/definitions/AmlFilesystemContainerStorageInterface", + "description": "Container Storage Interface information for the AML file system." + } + } + }, + "AmlFilesystemContainerStorageInterface": { + "type": "object", + "description": "AML file system container storage interface information", + "readOnly": true, + "properties": { + "persistentVolumeClaim": { + "description": "Recommended AKS Persistent Volume Claim for the CSI driver, in Base64 encoded YAML", + "readOnly": true, + "type": "string" + }, + "persistentVolume": { + "description": "Recommended AKS Persistent Volume for the CSI driver, in Base64 encoded YAML", + "readOnly": true, + "type": "string" + }, + "storageClass": { + "description": "Recommended AKS Storage Class for the CSI driver, in Base64 encoded YAML", + "readOnly": true, + "type": "string" + } + } + }, + "AmlFilesystemArchiveInfo": { + "type": "object", + "description": "Information required to execute the archive operation", + "properties": { + "filesystemPath": { + "type": "string", + "description": "Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data.", + "default": "/" + } + } + }, + "AmlFilesystemArchive": { + "description": "Information about the AML file system archive", + "type": "object", + "readOnly": true, + "properties": { + "filesystemPath": { + "readOnly": true, + "type": "string", + "description": "Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data." + }, + "status": { + "description": "The status of the archive", + "type": "object", + "readOnly": true, + "properties": { + "state": { + "readOnly": true, + "description": "The state of the archive operation", + "type": "string", + "enum": [ + "NotConfigured", + "Idle", + "InProgress", + "Canceled", + "Completed", + "Failed", + "Cancelling", + "FSScanInProgress" + ], + "x-ms-enum": { + "name": "ArchiveStatusType", + "modelAsString": true + } + }, + "lastCompletionTime": { + "readOnly": true, + "description": "The time of the last completed archive operation", + "type": "string", + "format": "date-time" + }, + "lastStartedTime": { + "readOnly": true, + "description": "The time the latest archive operation started", + "type": "string", + "format": "date-time" + }, + "percentComplete": { + "readOnly": true, + "description": "The completion percentage of the archive operation", + "type": "integer", + "format": "int32" + }, + "errorCode": { + "readOnly": true, + "description": "Server-defined error code for the archive operation", + "type": "string" + }, + "errorMessage": { + "readOnly": true, + "description": "Server-defined error message for the archive operation", + "type": "string" + } + } + } + } + }, + "RequiredAmlFilesystemSubnetsSizeInfo": { + "type": "object", + "description": "Information required to get the number of available IP addresses a subnet should have that will be used in AML file system create", + "properties": { + "storageCapacityTiB": { + "description": "The size of the AML file system, in TiB.", + "type": "number", + "format": "float" + }, + "sku": { + "description": "SKU for the resource.", + "$ref": "#/definitions/SkuName" + } + } + }, + "RequiredAmlFilesystemSubnetsSize": { + "type": "object", + "description": "Information about the number of available IP addresses that are required for the AML file system.", + "properties": { + "filesystemSubnetSize": { + "description": "The number of available IP addresses that are required for the AML file system.", + "type": "integer", + "format": "int32" + } + } + }, + "AmlFilesystemSubnetInfo": { + "type": "object", + "description": "Information required to validate the subnet that will be used in AML file system create", + "properties": { + "filesystemSubnet": { + "description": "Subnet used for managing the AML file system and for client-facing operations. This subnet should have at least a /24 subnet mask within the VNET's address space.", + "$ref": "storagecache.json#/definitions/URLString" + }, + "storageCapacityTiB": { + "description": "The size of the AML file system, in TiB.", + "type": "number", + "format": "float" + }, + "sku": { + "description": "SKU for the resource.", + "$ref": "#/definitions/SkuName" + }, + "location": { + "description": "Region that the AML file system will be created in.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "AmlFilesystemCheckSubnetError": { + "type": "object", + "description": "The error details provided when the checkAmlFSSubnets call fails.", + "readOnly": true, + "properties": { + "filesystemSubnet": { + "type": "object", + "description": "The error details for the AML file system's subnet.", + "properties": { + "status": { + "type": "string", + "enum": [ + "Ok", + "Invalid" + ], + "x-ms-enum": { + "name": "FilesystemSubnetStatusType", + "modelAsString": true + }, + "description": "The status of the AML file system subnet check." + }, + "message": { + "type": "string", + "description": "The details of the AML file system subnet check." + } + } + } + } + }, + "UserAssignedIdentities": { + "type": "object", + "description": "A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary.", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "userAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the user-assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client ID of the user-assigned identity." + } + } + } + }, + "SkuName": { + "x-ms-mutability": [ + "read", + "create" + ], + "description": "SKU for the resource.", + "properties": { + "name": { + "description": "SKU name for this resource.", + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": { + "AmlFilesystemNameParameter": { + "description": "Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.", + "in": "path", + "name": "amlFilesystemName", + "pattern": "^[0-9a-zA-Z][-0-9a-zA-Z_]{0,78}[0-9a-zA-Z]$", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 80, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/AscOperations_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/AscOperations_Get.json new file mode 100644 index 000000000000..163fd23d18d8 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/AscOperations_Get.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus", + "operationId": "testoperationid", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/ascOperations/testoperationid", + "name": "testoperationid", + "startTime": "2023-01-01T13:13:13.933Z", + "endTime": "2023-01-01T16:13:13.933Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/AscResourceUsages_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/AscResourceUsages_Get.json new file mode 100644 index 000000000000..c61eb64e3bd0 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/AscResourceUsages_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "limit": 4, + "unit": "Count", + "currentValue": 1, + "name": { + "value": "Cache", + "localizedValue": "Cache" + } + }, + { + "limit": 4, + "unit": "Count", + "currentValue": 0, + "name": { + "value": "AmlFilesystem", + "localizedValue": "AmlFilesystem" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_CreateOrUpdate.json new file mode 100644 index 000000000000..1a107113cbee --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_CreateOrUpdate.json @@ -0,0 +1,324 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cache": { + "tags": { + "Dept": "Contoso" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "cacheSizeGB": 3072, + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2047/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "cacheNetBiosName": "contosoSmb", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "credentials": { + "username": "consotoAdmin", + "password": "" + } + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "credentials": { + "bindDn": "cn=ldapadmin,dc=contosoad,dc=contoso,dc=local", + "bindPassword": "" + } + } + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + } + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "responses": { + "202": {}, + "201": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Succeeded", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "5.3.23", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "5.3.24" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "No" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "No" + } + }, + "primingJobs": [], + "spaceAllocation": [], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "200": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_CreateOrUpdate_ldap_only.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_CreateOrUpdate_ldap_only.json new file mode 100644 index 000000000000..573c4c96b8c3 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_CreateOrUpdate_ldap_only.json @@ -0,0 +1,291 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cache": { + "tags": { + "Dept": "Contoso" + }, + "location": "westus", + "properties": { + "cacheSizeGB": 3072, + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "credentials": { + "bindDn": "cn=ldapadmin,dc=contosoad,dc=contoso,dc=local", + "bindPassword": "" + } + } + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + } + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "responses": { + "202": {}, + "201": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Succeeded", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "5.3.23", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "5.3.24" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "No" + } + }, + "primingJobs": [], + "spaceAllocation": [], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "200": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_DebugInfo.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_DebugInfo.json new file mode 100644 index 000000000000..b09def3a2492 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_DebugInfo.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Delete.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Delete.json new file mode 100644 index 000000000000..b09def3a2492 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Flush.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Flush.json new file mode 100644 index 000000000000..b09def3a2492 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Flush.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Get.json new file mode 100644 index 000000000000..1f429bb03dd5 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Get.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Succeeded", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [ + { + "name": "st1", + "allocationPercentage": 25 + }, + { + "name": "st2", + "allocationPercentage": 50 + }, + { + "name": "st3", + "allocationPercentage": 25 + } + ], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_List.json new file mode 100644 index 000000000000..a806ebbaf852 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_List.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Succeeded", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [], + "spaceAllocation": [ + { + "name": "st1", + "allocationPercentage": 25 + }, + { + "name": "st2", + "allocationPercentage": 50 + }, + { + "name": "st3", + "allocationPercentage": 25 + } + ] + }, + "sku": { + "name": "Standard_2G" + } + }, + { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc2", + "location": "westus", + "name": "sc2", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub2", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "AD", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "", + "ldapBaseDN": "", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_ListByResourceGroup.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_ListByResourceGroup.json new file mode 100644 index 000000000000..c4f30684d47d --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_ListByResourceGroup.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Succeeded", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [], + "spaceAllocation": [ + { + "name": "st1", + "allocationPercentage": 25 + }, + { + "name": "st2", + "allocationPercentage": 50 + }, + { + "name": "st3", + "allocationPercentage": 25 + } + ], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + }, + { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc2", + "location": "westus", + "name": "sc2", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub2", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "AD", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "", + "ldapBaseDN": "", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [], + "zones": [ + "2" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Start.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Start.json new file mode 100644 index 000000000000..b09def3a2492 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Start.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Stop.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Stop.json new file mode 100644 index 000000000000..b09def3a2492 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Stop.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Update.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Update.json new file mode 100644 index 000000000000..6fc01b00b4a9 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Update.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cache": { + "tags": { + "Dept": "Contoso" + }, + "location": "westus", + "properties": { + "cacheSizeGB": 3072, + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + }, + { + "name": "restrictive", + "accessRules": [ + { + "scope": "host", + "filter": "10.99.3.145", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "network", + "filter": "10.99.1.0/24", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "default", + "access": "no", + "suid": false, + "submountAccess": true, + "rootSquash": true, + "anonymousUID": "65534", + "anonymousGID": "65534" + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "cacheNetBiosName": "contosoSmb", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "AD" + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "200": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + }, + { + "name": "restrictive", + "accessRules": [ + { + "scope": "host", + "filter": "10.99.3.145", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "network", + "filter": "10.99.1.0/24", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "default", + "access": "no", + "suid": false, + "submountAccess": true, + "rootSquash": true, + "anonymousUID": "65534", + "anonymousGID": "65534" + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "AD", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "", + "ldapBaseDN": "", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [ + { + "name": "st1", + "allocationPercentage": 25 + }, + { + "name": "st2", + "allocationPercentage": 50 + }, + { + "name": "st3", + "allocationPercentage": 25 + } + ] + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Update_ldap_only.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Update_ldap_only.json new file mode 100644 index 000000000000..8aabb5214d54 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_Update_ldap_only.json @@ -0,0 +1,241 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cache": { + "tags": { + "Dept": "Contoso" + }, + "location": "westus", + "properties": { + "cacheSizeGB": 3072, + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + }, + { + "name": "restrictive", + "accessRules": [ + { + "scope": "host", + "filter": "10.99.3.145", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "network", + "filter": "10.99.1.0/24", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "default", + "access": "no", + "suid": false, + "submountAccess": true, + "rootSquash": true, + "anonymousUID": "65534", + "anonymousGID": "65534" + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "credentials": { + "bindDn": "cn=ldapadmin,dc=contosoad,dc=contoso,dc=local", + "bindPassword": "" + } + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "200": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + }, + { + "name": "restrictive", + "accessRules": [ + { + "scope": "host", + "filter": "10.99.3.145", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "network", + "filter": "10.99.1.0/24", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "default", + "access": "no", + "suid": false, + "submountAccess": true, + "rootSquash": true, + "anonymousUID": "65534", + "anonymousGID": "65534" + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "No" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [] + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_UpgradeFirmware.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_UpgradeFirmware.json new file mode 100644 index 000000000000..40c8c289fb1a --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Caches_UpgradeFirmware.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "201": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Operations_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..eb9e60717122 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Operations_List.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview", + "x-ms-client-request-id": [ + "7e655b68-e491-4cb6-90c3-6a5b10b7bd17" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.StorageCache/caches/write", + "display": { + "operation": "Create or Update Cache", + "provider": "Azure Storage Cache", + "resource": "Caches" + } + }, + { + "name": "Microsoft.StorageCache/caches/delete", + "display": { + "operation": "Delete Cache", + "provider": "Azure Storage Cache", + "resource": "Caches" + } + }, + { + "origin": "system", + "name": "Microsoft.StorageCache/caches/providers/Microsoft.Insights/metricDefinitions/read", + "isDataAction": false, + "display": { + "operation": "Get Cache Metric Definitions", + "provider": "Microsoft Azure HPC Cache", + "resource": "StorageCache Metric Definitions", + "description": "Reads Cache Metric Definitions." + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "ClientIOPS", + "displayName": "Total Client IOPS", + "displayDescription": "The rate of client file operations processed by the Cache.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricClass": "Transactions" + }, + { + "name": "ClientLatency", + "displayName": "Average Client Latency", + "displayDescription": "Average latency of client file operations to the Cache.", + "unit": "Milliseconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricClass": "Latency" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/PausePrimingJob.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/PausePrimingJob.json new file mode 100644 index 000000000000..4c23ac9d4398 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/PausePrimingJob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1", + "primingJobId": { + "primingJobId": "00000000000_0000000000" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/44444444-4444-4444-4444-444444444444?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/44444444-4444-4444-4444-444444444444?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/ResumePrimingJob.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/ResumePrimingJob.json new file mode 100644 index 000000000000..89add0ff8778 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/ResumePrimingJob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1", + "primingJobId": { + "primingJobId": "00000000000_0000000000" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/55555555-5555-5555-5555-555555555555?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/55555555-5555-5555-5555-555555555555?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Skus_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Skus_List.json new file mode 100644 index 000000000000..cfdbbafc208e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/Skus_List.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "caches", + "name": "Standard_2G", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [] + } + ], + "capabilities": [ + { + "name": "throughput GB/s", + "value": "2" + }, + { + "name": "cache sizes(GB)", + "value": "3072,6144,12288" + } + ], + "restrictions": [] + }, + { + "resourceType": "caches", + "name": "Standard_4G", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [] + } + ], + "capabilities": [ + { + "name": "throughput GB/s", + "value": "4" + }, + { + "name": "cache sizes(GB)", + "value": "6144,12288,24576" + } + ], + "restrictions": [] + }, + { + "resourceType": "caches", + "name": "Standard_8G", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [] + } + ], + "capabilities": [ + { + "name": "throughput GB/s", + "value": "8" + }, + { + "name": "cache sizes(GB)", + "value": "12288,24576,49152" + } + ], + "restrictions": [] + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/SpaceAllocation_Post.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/SpaceAllocation_Post.json new file mode 100644 index 000000000000..7963efb3da72 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/SpaceAllocation_Post.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1", + "spaceAllocation": [ + { + "name": "st1", + "allocationPercentage": 25 + }, + { + "name": "st2", + "allocationPercentage": 50 + }, + { + "name": "st3", + "allocationPercentage": 25 + } + ] + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/11111111-1111-1111-1111-111111111111?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/11111111-1111-1111-1111-111111111111?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StartPrimingJob.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StartPrimingJob.json new file mode 100644 index 000000000000..c5afc2132636 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StartPrimingJob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1", + "primingjob": { + "primingJobName": "contosoJob", + "primingManifestUrl": "https://contosostorage.blob.core.windows.net/contosoblob/00000000_00000000000000000000000000000000.00000000000.FFFFFFFF.00000000?sp=r&st=2021-08-11T19:33:35Z&se=2021-08-12T03:33:35Z&spr=https&sv=2020-08-04&sr=b&sig=" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/22222222-2222-2222-2222-222222222222?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/22222222-2222-2222-2222-222222222222?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StopPrimingJob.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StopPrimingJob.json new file mode 100644 index 000000000000..270a345c6ac5 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StopPrimingJob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1", + "primingJobId": { + "primingJobId": "00000000000_0000000000" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/33333333-3333-3333-3333-333333333333?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/33333333-3333-3333-3333-333333333333?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_CreateOrUpdate.json new file mode 100644 index 000000000000..a610fbc901b5 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_CreateOrUpdate.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1", + "storageTargetName": "st1", + "storagetarget": { + "properties": { + "junctions": [ + { + "namespacePath": "/path/on/cache", + "targetPath": "/path/on/exp1", + "nfsExport": "exp1", + "nfsAccessPolicy": "default" + }, + { + "namespacePath": "/path2/on/cache", + "targetPath": "/path2/on/exp2", + "nfsExport": "exp2", + "nfsAccessPolicy": "rootSquash" + } + ], + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/path/on/cache", + "targetPath": "/path/on/exp1", + "nfsExport": "exp1", + "nfsAccessPolicy": "default" + }, + { + "namespacePath": "/path2/on/cache", + "targetPath": "/path2/on/exp2", + "nfsExport": "exp2", + "nfsAccessPolicy": "rootSquash" + } + ], + "state": "Ready", + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "201": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/path/on/cache", + "targetPath": "/path/on/exp1", + "nfsExport": "exp1", + "nfsAccessPolicy": "default" + }, + { + "namespacePath": "/path2/on/cache", + "targetPath": "/path2/on/exp2", + "nfsExport": "exp2", + "nfsAccessPolicy": "rootSquash" + } + ], + "state": "Ready", + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "202": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_CreateOrUpdate_BlobNfs.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_CreateOrUpdate_BlobNfs.json new file mode 100644 index 000000000000..830f5331c070 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_CreateOrUpdate_BlobNfs.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1", + "storageTargetName": "st1", + "storagetarget": { + "properties": { + "targetType": "blobNfs", + "junctions": [ + { + "namespacePath": "/blobnfs" + } + ], + "blobNfs": { + "target": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/blofnfs/blobServices/default/containers/blobnfs", + "usageModel": "READ_WRITE", + "verificationTimer": 28800, + "writeBackTimer": 3600 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "targetType": "blobNfs", + "junctions": [ + { + "namespacePath": "/blobnfs" + } + ], + "state": "Ready", + "blobNfs": { + "target": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/blofnfs/blobServices/default/containers/blobnfs", + "usageModel": "READ_WRITE", + "verificationTimer": 28800, + "writeBackTimer": 3600 + } + } + } + }, + "201": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "targetType": "blobNfs", + "junctions": [ + { + "namespacePath": "/blobnfs" + } + ], + "state": "Ready", + "blobNfs": { + "target": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/blofnfs/blobServices/default/containers/blobnfs", + "usageModel": "READ_WRITE", + "verificationTimer": 28800, + "writeBackTimer": 3600 + } + } + } + }, + "202": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_CreateOrUpdate_NoJunctions.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_CreateOrUpdate_NoJunctions.json new file mode 100644 index 000000000000..3c6c78ca214a --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_CreateOrUpdate_NoJunctions.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1", + "storageTargetName": "st1", + "storagetarget": { + "properties": { + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "targetType": "nfs3", + "state": "Ready", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "201": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "targetType": "nfs3", + "state": "Ready", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "202": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Delete.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Delete.json new file mode 100644 index 000000000000..ba07c1a5d2bd --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_DnsRefresh.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_DnsRefresh.json new file mode 100644 index 000000000000..d6e20d4a8e38 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_DnsRefresh.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Flush.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Flush.json new file mode 100644 index 000000000000..e65a7e51283e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Flush.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Get.json new file mode 100644 index 000000000000..c4f6592a446d --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1", + "storageTargetName": "st1" + }, + "responses": { + "200": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/path/on/cache", + "targetPath": "/path/on/exp1", + "nfsExport": "exp1", + "nfsAccessPolicy": "default" + }, + { + "namespacePath": "/path2/on/cache", + "targetPath": "/path2/on/exp2", + "nfsExport": "exp2", + "nfsAccessPolicy": "default" + } + ], + "state": "Ready", + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_HEAVY_FREQ" + }, + "allocationPercentage": 25 + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Invalidate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Invalidate.json new file mode 100644 index 000000000000..e65a7e51283e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Invalidate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_ListByCache.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_ListByCache.json new file mode 100644 index 000000000000..50b8a22508bd --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_ListByCache.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "cacheName": "sc1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/path/on/cache", + "targetPath": "/path/on/exp1", + "nfsExport": "exp1", + "nfsAccessPolicy": "default" + }, + { + "namespacePath": "/path2/on/cache", + "targetPath": "/path2/on/exp2", + "nfsExport": "exp2", + "nfsAccessPolicy": "default" + } + ], + "state": "Ready", + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY" + }, + "allocationPercentage": 25 + } + }, + { + "name": "st2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st2", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/some/arbitrary/place/on/cache", + "targetPath": "/", + "nfsAccessPolicy": "default" + } + ], + "state": "Ready", + "targetType": "clfs", + "clfs": { + "target": "https://contoso123.blob.core.windows.net/contoso123" + }, + "allocationPercentage": 50 + } + }, + { + "name": "st3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st3", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/some/crazier/place/on/cache", + "targetPath": "/", + "nfsExport": "", + "nfsAccessPolicy": "default" + } + ], + "state": "Ready", + "targetType": "unknown", + "unknown": { + "attributes": { + "foo": "bar", + "foo2": "test" + } + }, + "allocationPercentage": 25 + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_RestoreDefaults.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_RestoreDefaults.json new file mode 100644 index 000000000000..d6e20d4a8e38 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_RestoreDefaults.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Resume.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Resume.json new file mode 100644 index 000000000000..e65a7e51283e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Resume.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Suspend.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Suspend.json new file mode 100644 index 000000000000..e65a7e51283e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/StorageTargets_Suspend.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/UsageModels_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/UsageModels_List.json new file mode 100644 index 000000000000..7538e8dc5f03 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/UsageModels_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "modelName": "READ_ONLY", + "targetType": "nfs3", + "display": { + "description": "Read only, with a default verification timer of 30 seconds. Verification timer has a minimum value of 1 and maximum value of 31536000. Write-back timer must have value of 0 or be null." + } + }, + { + "modelName": "READ_WRITE", + "targetType": "nfs3", + "display": { + "description": "Read-write, with a default verification timer of 8 hours and default write-back timer of 1 hour. Verification timer and write-back timer have a minimum value of 1 and maximum value of 31536000." + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Archive.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Archive.json new file mode 100644 index 000000000000..30eb0ae2e735 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Archive.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "archiveInfo": { + "filesystemPath": "/" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_CancelArchive.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_CancelArchive.json new file mode 100644 index 000000000000..67ed8886a2ee --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_CancelArchive.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_CreateOrUpdate.json new file mode 100644 index 000000000000..49f903a6f168 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_CreateOrUpdate.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "fs1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "amlFilesystem": { + "tags": { + "Dept": "ContosoAds" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "eastus", + "zones": [ + "1" + ], + "properties": { + "storageCapacityTiB": 16, + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + } + }, + "rootSquashSettings": { + "mode": "All", + "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp", + "squashUID": 99, + "squashGID": 99 + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-11-01-preview" + }, + "body": { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + } + }, + "rootSquashSettings": { + "mode": "All", + "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp", + "squashUID": 99, + "squashGID": 99, + "status": "nodemap.active=1" + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + }, + "200": { + "body": { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + }, + "rootSquashSettings": { + "mode": "All", + "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp", + "squashUID": 99, + "squashGID": 99, + "status": "nodemap.active=1" + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Delete.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Delete.json new file mode 100644 index 000000000000..4db94a43a9e9 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "fs1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Get.json new file mode 100644 index 000000000000..25338af52dae --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Get.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "fs1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + }, + "rootSquashSettings": { + "mode": "All", + "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp", + "squashUID": 99, + "squashGID": 99, + "status": "nodemap.active=1" + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_List.json new file mode 100644 index 000000000000..893e06d24b9e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_List.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub1", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + }, + "rootSquashSettings": { + "mode": "All", + "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp", + "squashUID": 99, + "squashGID": 99, + "status": "nodemap.active=1" + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + }, + { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs2", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs2", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub2", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + }, + "rootSquashSettings": { + "mode": "All", + "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp", + "squashUID": 99, + "squashGID": 99, + "status": "nodemap.active=1" + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_ListByResourceGroup.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_ListByResourceGroup.json new file mode 100644 index 000000000000..29bf8f062b89 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_ListByResourceGroup.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub1", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + }, + "rootSquashSettings": { + "mode": "All", + "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp", + "squashUID": 99, + "squashGID": 99, + "status": "nodemap.active=1" + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + }, + { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs2", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs2", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub2", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + }, + "rootSquashSettings": { + "mode": "All", + "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp", + "squashUID": 99, + "squashGID": 99, + "status": "nodemap.active=1" + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Update.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Update.json new file mode 100644 index 000000000000..ad128598a495 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/amlFilesystems_Update.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "fs1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "amlFilesystem": { + "tags": { + "Dept": "ContosoAds" + }, + "properties": { + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "rootSquashSettings": { + "mode": "All", + "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp", + "squashUID": 99, + "squashGID": 99 + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-11-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" + } + }, + "200": { + "body": { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + }, + "rootSquashSettings": { + "mode": "All", + "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp", + "squashUID": 99, + "squashGID": 99, + "status": "nodemap.active=1" + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/checkAmlFSSubnets.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/checkAmlFSSubnets.json new file mode 100644 index 000000000000..d9d17f45ea9b --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/checkAmlFSSubnets.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "amlFilesystemSubnetInfo": { + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "storageCapacityTiB": 16, + "sku": { + "name": "AMLFS-Durable-Premium-125" + } + } + }, + "responses": { + "200": {}, + "400": { + "body": { + "filesystemSubnet": { + "status": "Invalid", + "message": "A subnet with a minimum size of /24 is required." + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/getRequiredAmlFSSubnetsSize.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/getRequiredAmlFSSubnetsSize.json new file mode 100644 index 000000000000..597236a81add --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/examples/getRequiredAmlFSSubnetsSize.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview", + "amlFilesystemSubnetInfo": { + "storageCapacityTiB": 16, + "sku": { + "name": "AMLFS-Durable-Premium-125" + } + } + }, + "responses": { + "200": { + "body": { + "filesystemSubnetSize": 24 + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/storagecache.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/storagecache.json new file mode 100644 index 000000000000..6657dea41e32 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/preview/2023-11-01-preview/storagecache.json @@ -0,0 +1,3495 @@ +{ + "swagger": "2.0", + "info": { + "description": "A Storage Cache provides scalable caching service for NAS clients, serving data from either NFSv3 or Blob at-rest storage (referred to as \"Storage Targets\"). These operations allow you to manage Caches.", + "title": "Storage Cache Mgmt Client", + "version": "2023-11-01-preview" + }, + "host": "management.azure.com", + "basePath": "/", + "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.StorageCache/operations": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of available Resource Provider operations.", + "schema": { + "$ref": "#/definitions/ApiOperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "tags": [ + "Operations" + ], + "description": "Lists all of the available Resource Provider operations.", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "operationId": "Operations_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/skus": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of SKU descriptors.", + "schema": { + "$ref": "#/definitions/ResourceSkusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Skus_List": { + "$ref": "./examples/Skus_List.json" + } + }, + "tags": [ + "SKUs" + ], + "description": "Get the list of StorageCache.Cache SKUs available to this subscription.", + "operationId": "Skus_List" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/usageModels": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of UsageModel descriptors.", + "schema": { + "$ref": "#/definitions/UsageModelsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "UsageModels_List": { + "$ref": "./examples/UsageModels_List.json" + } + }, + "tags": [ + "UsageModels" + ], + "description": "Get the list of cache usage models available to this subscription.", + "operationId": "UsageModels_List" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/ascOperations/{operationId}": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "The asynchronous operation was returned.", + "schema": { + "$ref": "#/definitions/AscOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AscOperations_Get": { + "$ref": "./examples/AscOperations_Get.json" + } + }, + "tags": [ + "AscOperations" + ], + "description": "Gets the status of an asynchronous operation for the Azure HPC Cache", + "operationId": "AscOperations_Get" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/usages": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the region to query for usage information." + } + ], + "responses": { + "200": { + "description": "The usage information was returned.", + "schema": { + "$ref": "#/definitions/ResourceUsagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AscUsages_List": { + "$ref": "./examples/AscResourceUsages_Get.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "AscUsages" + ], + "description": "Gets the quantity used and quota limit for resources", + "operationId": "AscUsages_List" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of cache objects. Note that entity references might replace complete cache objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference", + "schema": { + "$ref": "#/definitions/CachesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Caches_List": { + "$ref": "./examples/Caches_List.json" + } + }, + "tags": [ + "Caches" + ], + "description": "Returns all caches the user has access to under a subscription.", + "operationId": "Caches_List" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of cache objects. Note that entity references might replace complete cache objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference", + "schema": { + "$ref": "#/definitions/CachesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_ListByResourceGroup": { + "$ref": "./examples/Caches_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "Caches" + ], + "description": "Returns all caches the user has access to under a resource group.", + "operationId": "Caches_ListByResourceGroup" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}": { + "delete": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Cache deleted." + }, + "202": { + "description": "Started the cache's transition to Deleted state. Poll the cache to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Cache deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Delete": { + "$ref": "./examples/Caches_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "tags": [ + "Caches" + ], + "description": "Schedules a cache for deletion.", + "operationId": "Caches_Delete" + }, + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the cache object corresponding to cache name.", + "schema": { + "$ref": "#/definitions/Cache" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Get": { + "$ref": "./examples/Caches_Get.json" + } + }, + "tags": [ + "Caches" + ], + "description": "Returns a cache.", + "operationId": "Caches_Get" + }, + "put": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "description": "Object containing the user-selectable properties of the new cache. If read-only properties are included, they must match the existing values of those properties.", + "in": "body", + "name": "cache", + "required": true, + "schema": { + "$ref": "#/definitions/Cache" + } + } + ], + "responses": { + "200": { + "description": "Cache created or updated.", + "schema": { + "$ref": "#/definitions/Cache" + } + }, + "201": { + "description": "Cache creation or update has been initiated. Poll the cache's provisioningState property to monitor creation/update progress.", + "schema": { + "$ref": "#/definitions/Cache" + } + }, + "202": { + "description": "Cache creation or update has been initiated. Poll the cache's provisioningState property to monitor creation/update progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_CreateOrUpdate": { + "$ref": "./examples/Caches_CreateOrUpdate.json" + }, + "Caches_CreateOrUpdate_ldap_only": { + "$ref": "./examples/Caches_CreateOrUpdate_ldap_only.json" + } + }, + "x-ms-long-running-operation": true, + "tags": [ + "Caches" + ], + "description": "Create or update a cache.", + "operationId": "Caches_CreateOrUpdate" + }, + "patch": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "description": "Object containing the user-selectable properties of the cache. If read-only properties are included, they must match the existing values of those properties.", + "in": "body", + "name": "cache", + "schema": { + "$ref": "#/definitions/Cache" + } + } + ], + "responses": { + "200": { + "description": "Updated the cache.", + "schema": { + "$ref": "#/definitions/Cache" + } + }, + "202": { + "description": "Cache update has been initiated. Poll the cache's provisioningState property to monitor update progress.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Update": { + "$ref": "./examples/Caches_Update.json" + }, + "Caches_Update_ldap_only": { + "$ref": "./examples/Caches_Update_ldap_only.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Update a cache instance.", + "operationId": "Caches_Update" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/dnsRefresh": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "Cache has refreshed the storage target's DNS information." + }, + "202": { + "description": "Cache has started refreshing storage target DNS information.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_DnsRefresh": { + "$ref": "./examples/StorageTargets_DnsRefresh.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "StorageTargets" + ], + "description": "Tells a storage target to refresh its DNS information.", + "operationId": "StorageTargets_DnsRefresh" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/debugInfo": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Cache has started generating debug info." + }, + "202": { + "description": "Cache has started generating debug info.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Cache has started generating debug info." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_DebugInfo": { + "$ref": "./examples/Caches_DebugInfo.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Tells a cache to write generate debug info for support to process.", + "operationId": "Caches_DebugInfo" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/flush": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "All cached data has been flushed to the Storage Target(s)." + }, + "202": { + "description": "Cache has started flushing to its Storage Target(s). Poll the cache's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Cache flush already in progress or has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Flush": { + "$ref": "./examples/Caches_Flush.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Tells a cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.", + "operationId": "Caches_Flush" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/start": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Cache is Active." + }, + "202": { + "description": "Cache has started the transition to Active. Poll the cache's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Restarted VMs associated with the cache." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Start": { + "$ref": "./examples/Caches_Start.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Tells a Stopped state cache to transition to Active state.", + "operationId": "Caches_Start" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stop": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Cache is stopped." + }, + "202": { + "description": "Cache has started the transition to Stopped. Poll the cache's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Stopped VMs associated with the cache." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Stop": { + "$ref": "./examples/Caches_Stop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Tells an Active cache to transition to Stopped state.", + "operationId": "Caches_Stop" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Returns the list of Storage Targets defined by cache name.", + "schema": { + "$ref": "#/definitions/StorageTargetsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_List": { + "$ref": "./examples/StorageTargets_ListByCache.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "StorageTargets" + ], + "description": "Returns a list of Storage Targets for the specified cache.", + "operationId": "StorageTargets_ListByCache" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}": { + "delete": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "string", + "description": "Boolean value requesting the force delete operation for a storage target. Force delete discards unwritten-data in the cache instead of flushing it to back-end storage." + } + ], + "responses": { + "200": { + "description": "Storage Target deleted." + }, + "202": { + "description": "Started the Storage Target's deletion. Poll the cache's Storage Targets to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Storage Target deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Delete": { + "$ref": "./examples/StorageTargets_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "tags": [ + "StorageTargets" + ], + "description": "Removes a Storage Target from a cache. This operation is allowed at any time, but if the cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the cache is healthy again. Note that if the cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.", + "operationId": "StorageTargets_Delete" + }, + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "Returns the Storage Target object corresponding to storageTargetName.", + "schema": { + "$ref": "#/definitions/StorageTarget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Get": { + "$ref": "./examples/StorageTargets_Get.json" + } + }, + "tags": [ + "StorageTargets" + ], + "description": "Returns a Storage Target from a cache.", + "operationId": "StorageTargets_Get" + }, + "put": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + }, + { + "description": "Object containing the definition of a Storage Target.", + "in": "body", + "name": "storagetarget", + "required": true, + "schema": { + "$ref": "#/definitions/StorageTarget" + } + } + ], + "responses": { + "200": { + "description": "Storage Target has been created or updated.", + "schema": { + "$ref": "#/definitions/StorageTarget" + } + }, + "201": { + "description": "Storage Target creation or update has been initiated. Poll the Storage Target's provisioningState property to monitor creation/update progress.", + "schema": { + "$ref": "#/definitions/StorageTarget" + } + }, + "202": { + "description": "Storage Target creation or update has been initiated. Poll the Storage Target's provisioningState property to monitor creation/update progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_CreateOrUpdate": { + "$ref": "./examples/StorageTargets_CreateOrUpdate.json" + }, + "StorageTargets_CreateOrUpdate_NoJunctions": { + "$ref": "./examples/StorageTargets_CreateOrUpdate_NoJunctions.json" + }, + "StorageTargets_CreateOrUpdate_BlobNfs": { + "$ref": "./examples/StorageTargets_CreateOrUpdate_BlobNfs.json" + } + }, + "x-ms-long-running-operation": true, + "tags": [ + "StorageTargets" + ], + "description": "Create or update a Storage Target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the cache is healthy again.", + "operationId": "StorageTargets_CreateOrUpdate" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/flush": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "All data has been flushed to the storage target." + }, + "202": { + "description": "Cache has started flushing to the storage target. Poll the storage target's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Flush already in progress or has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Flush": { + "$ref": "./examples/StorageTargets_Flush.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "StorageTargets" + ], + "description": "Tells the cache to write all dirty data to the Storage Target's backend storage. Client requests to this storage target's namespace will return errors until the flush operation completes.", + "operationId": "StorageTarget_Flush" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/suspend": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "Client access to the storage target has been suspended." + }, + "202": { + "description": "Storage target suspend has started. Poll the storage target's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The storage target is already suspended or suspend is in progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Suspend": { + "$ref": "./examples/StorageTargets_Suspend.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "StorageTargets" + ], + "description": "Suspends client access to a storage target.", + "operationId": "StorageTarget_Suspend" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/resume": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "Client access to the storage target has been resumed." + }, + "202": { + "description": "Storage target resume has started. Poll the storage target's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The storage target has already resumed or resume is in progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Resume": { + "$ref": "./examples/StorageTargets_Resume.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "StorageTargets" + ], + "description": "Resumes client access to a previously suspended storage target.", + "operationId": "StorageTarget_Resume" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/invalidate": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "All cached data for the storage target was invalidated" + }, + "202": { + "description": "Storage target invalidation has started. Poll the storage target's state field to monitor progress.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The storage target already has been invalidated, or invalidate is in progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Invalidate": { + "$ref": "./examples/StorageTargets_Invalidate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "StorageTargets" + ], + "description": "Invalidate all cached data for a storage target. Cached files are discarded and fetched from the back end on the next request.", + "operationId": "StorageTarget_Invalidate" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/startPrimingJob": { + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "description": "Object containing the definition of a priming job.", + "in": "body", + "name": "primingjob", + "schema": { + "$ref": "#/definitions/PrimingJob" + } + } + ], + "responses": { + "202": { + "description": "The priming job is being created and will complete asynchronously.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StartPrimingJob": { + "$ref": "./examples/StartPrimingJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Create a priming job. This operation is only allowed when the cache is healthy.", + "operationId": "Caches_StartPrimingJob" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stopPrimingJob": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "description": "Object containing the priming job ID.", + "in": "body", + "name": "primingJobId", + "schema": { + "$ref": "#/definitions/PrimingJobIdParameter" + } + } + ], + "responses": { + "202": { + "description": "Started priming job deletion.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The priming job is being deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StopPrimingJob": { + "$ref": "./examples/StopPrimingJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Schedule a priming job for deletion.", + "operationId": "Caches_StopPrimingJob" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/pausePrimingJob": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "description": "Object containing the priming job ID.", + "in": "body", + "name": "primingJobId", + "schema": { + "$ref": "#/definitions/PrimingJobIdParameter" + } + } + ], + "responses": { + "202": { + "description": "Priming job is being paused.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The priming job is paused." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PausePrimingJob": { + "$ref": "./examples/PausePrimingJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Schedule a priming job to be paused.", + "operationId": "Caches_PausePrimingJob" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/resumePrimingJob": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "description": "Object containing the priming job ID.", + "in": "body", + "name": "primingJobId", + "schema": { + "$ref": "#/definitions/PrimingJobIdParameter" + } + } + ], + "responses": { + "202": { + "description": "Priming job is being resumed.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The priming job is running." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResumePrimingJob": { + "$ref": "./examples/ResumePrimingJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Resumes a paused priming job.", + "operationId": "Caches_ResumePrimingJob" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/upgrade": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "201": { + "description": "Cache firmware is up to date." + }, + "202": { + "description": "Cache has started the upgrade. Poll the cache's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Cache firmware is up to date." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_UpgradeFirmware": { + "$ref": "./examples/Caches_UpgradeFirmware.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.", + "operationId": "Caches_UpgradeFirmware" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/spaceAllocation": { + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "description": "List containing storage target cache space percentage allocations.", + "in": "body", + "name": "spaceAllocation", + "schema": { + "$ref": "#/definitions/SpaceAllocationParameter" + } + } + ], + "responses": { + "202": { + "description": "Error response describing why the operation failed.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SpaceAllocation_Post": { + "$ref": "./examples/SpaceAllocation_Post.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Update cache space allocation.", + "operationId": "Caches_SpaceAllocation" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/restoreDefaults": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "Cache has restored the storage target's settings to their default values." + }, + "202": { + "description": "Cache has started restoring the storage target's settings to their default values.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_RestoreDefaults": { + "$ref": "./examples/StorageTargets_RestoreDefaults.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "tags": [ + "StorageTargets" + ], + "description": "Tells a storage target to restore its settings to their default values.", + "operationId": "StorageTargets_RestoreDefaults" + } + } + }, + "definitions": { + "ApiOperation": { + "description": "REST API operation description: see https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#r3023-operationsapiimplementation", + "properties": { + "display": { + "type": "object", + "description": "The object that represents the operation.", + "properties": { + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft.StorageCache", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Cache, etc.", + "type": "string" + }, + "description": { + "description": "The description of the operation", + "type": "string" + } + } + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "isDataAction": { + "description": "The flag that indicates whether the operation applies to data plane.", + "type": "boolean" + }, + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Additional details about an operation.", + "type": "object", + "properties": { + "serviceSpecification": { + "type": "object", + "description": "Specification of the all the metrics provided for a resource type.", + "properties": { + "metricSpecifications": { + "description": "Details about operations related to metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "logSpecifications": { + "description": "Details about operations related to logs.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + } + } + }, + "type": "object" + }, + "ApiOperationListResult": { + "description": "Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + }, + "value": { + "description": "List of Resource Provider operations supported by the Microsoft.StorageCache resource provider.", + "items": { + "$ref": "#/definitions/ApiOperation" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "CloudError": { + "x-ms-external": true, + "description": "An error response.", + "properties": { + "error": { + "description": "The body of the error.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object" + }, + "CloudErrorBody": { + "description": "An error response.", + "properties": { + "code": { + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", + "type": "string" + }, + "details": { + "description": "A list of additional details about the error.", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", + "type": "string" + }, + "target": { + "description": "The target of the particular error. For example, the name of the property in error.", + "type": "string" + } + }, + "type": "object" + }, + "AscOperation": { + "description": "The status of operation.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The operation Id." + }, + "name": { + "type": "string", + "description": "The operation name." + }, + "startTime": { + "type": "string", + "description": "The start time of the operation." + }, + "endTime": { + "type": "string", + "description": "The end time of the operation." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "error": { + "type": "object", + "description": "The error detail of the operation if any.", + "$ref": "#/definitions/ErrorResponse" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Additional operation-specific properties", + "$ref": "#/definitions/AscOperationProperties" + } + } + }, + "AscOperationProperties": { + "type": "object", + "description": "Additional operation-specific output.", + "properties": { + "output": { + "type": "object", + "description": "Additional operation-specific output.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "Cache": { + "description": "A cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "id": { + "description": "Resource ID of the cache.", + "readOnly": true, + "$ref": "#/definitions/URLString" + }, + "location": { + "description": "Region name string.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "Name of cache.", + "readOnly": true, + "$ref": "#/definitions/ResourceName" + }, + "type": { + "description": "Type of the cache; Microsoft.StorageCache/Cache", + "readOnly": true, + "type": "string" + }, + "identity": { + "$ref": "#/definitions/CacheIdentity", + "description": "The identity of the cache, if configured." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the cache.", + "properties": { + "cacheSizeGB": { + "description": "The size of this Cache, in GB.", + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "health": { + "description": "Health of the cache.", + "readOnly": true, + "$ref": "#/definitions/CacheHealth" + }, + "mountAddresses": { + "description": "Array of IPv4 addresses that can be used by clients mounting this cache.", + "readOnly": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "provisioningState": { + "description": "ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningStateType", + "modelAsString": true + }, + "type": "string", + "readOnly": true + }, + "subnet": { + "description": "Subnet used for the cache.", + "$ref": "#/definitions/URLString", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeStatus": { + "description": "Upgrade status of the cache.", + "$ref": "#/definitions/CacheUpgradeStatus", + "readOnly": true + }, + "upgradeSettings": { + "description": "Upgrade settings of the cache.", + "$ref": "#/definitions/CacheUpgradeSettings" + }, + "networkSettings": { + "$ref": "#/definitions/CacheNetworkSettings", + "description": "Specifies network settings of the cache." + }, + "encryptionSettings": { + "$ref": "#/definitions/CacheEncryptionSettings", + "description": "Specifies encryption settings of the cache." + }, + "securitySettings": { + "$ref": "#/definitions/CacheSecuritySettings", + "description": "Specifies security settings of the cache." + }, + "directoryServicesSettings": { + "$ref": "#/definitions/CacheDirectorySettings", + "description": "Specifies Directory Services settings of the cache." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability zones for resources. This field should only contain a single element in the array.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "primingJobs": { + "$ref": "#/definitions/PrimingJobList", + "description": "Specifies the priming jobs defined in the cache." + }, + "spaceAllocation": { + "$ref": "#/definitions/SpaceAllocationList", + "description": "Specifies the space allocation percentage for each storage target in the cache." + } + }, + "type": "object" + }, + "sku": { + "x-ms-mutability": [ + "read", + "create" + ], + "description": "SKU for the cache.", + "properties": { + "name": { + "description": "SKU name for this cache.", + "type": "string" + } + }, + "type": "object" + } + }, + "x-ms-azure-resource": true, + "type": "object" + }, + "CacheIdentity": { + "type": "object", + "description": "Cache identity properties.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID for the system-assigned identity of the cache." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID associated with the cache." + }, + "type": { + "type": "string", + "description": "The type of identity used for the cache", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "CacheIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary.", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "userAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the user-assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client ID of the user-assigned identity." + } + } + } + } + } + }, + "CacheNetworkSettings": { + "type": "object", + "description": "Cache network settings.", + "properties": { + "mtu": { + "description": "The IPv4 maximum transmission unit configured for the subnet.", + "type": "integer", + "format": "int32", + "minimum": 576, + "maximum": 1500, + "default": 1500 + }, + "utilityAddresses": { + "description": "Array of additional IP addresses used by this cache.", + "readOnly": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "dnsServers": { + "description": "DNS servers for the cache to use. It will be set from the network configuration if no value is provided.", + "type": "array", + "items": { + "type": "string" + } + }, + "dnsSearchDomain": { + "description": "DNS search domain", + "type": "string" + }, + "ntpServer": { + "description": "NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.", + "type": "string", + "default": "time.windows.com" + } + } + }, + "CacheEncryptionSettings": { + "type": "object", + "description": "Cache encryption settings.", + "properties": { + "keyEncryptionKey": { + "x-ms-secret": true, + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the key encryption key in key vault." + }, + "rotationToLatestKeyVersionEnabled": { + "type": "boolean", + "description": "Specifies whether the service will automatically rotate to the newest version of the key in the key vault." + } + } + }, + "CacheSecuritySettings": { + "type": "object", + "description": "Cache security settings.", + "properties": { + "accessPolicies": { + "description": "NFS access policies defined for this cache.", + "items": { + "$ref": "#/definitions/NfsAccessPolicy" + }, + "type": "array", + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "CacheDirectorySettings": { + "description": "Cache Directory Services settings.", + "type": "object", + "properties": { + "activeDirectory": { + "$ref": "#/definitions/CacheActiveDirectorySettings", + "description": "Specifies settings for joining the HPC Cache to an Active Directory domain." + }, + "usernameDownload": { + "$ref": "#/definitions/CacheUsernameDownloadSettings", + "description": "Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups." + } + } + }, + "CacheActiveDirectorySettings": { + "description": "Active Directory settings used to join a cache to a domain.", + "properties": { + "primaryDnsIpAddress": { + "description": "Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.", + "type": "string" + }, + "secondaryDnsIpAddress": { + "description": "Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.", + "type": "string" + }, + "domainName": { + "description": "The fully qualified domain name of the Active Directory domain controller.", + "type": "string" + }, + "domainNetBiosName": { + "description": "The Active Directory domain's NetBIOS name.", + "type": "string" + }, + "cacheNetBiosName": { + "description": "The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].", + "pattern": "^[-0-9a-zA-Z]{1,15}$", + "type": "string" + }, + "domainJoined": { + "description": "True if the HPC Cache is joined to the Active Directory domain.", + "type": "string", + "readOnly": true, + "enum": [ + "Yes", + "No", + "Error" + ], + "x-ms-enum": { + "name": "DomainJoinedType", + "modelAsString": true + } + }, + "credentials": { + "type": "object", + "description": "Active Directory admin credentials used to join the HPC Cache to a domain.", + "properties": { + "username": { + "description": "Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.", + "type": "string" + }, + "password": { + "description": "Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.", + "x-ms-secret": true, + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + }, + "required": [ + "username" + ] + } + }, + "type": "object", + "required": [ + "primaryDnsIpAddress", + "domainNetBiosName", + "domainName", + "cacheNetBiosName" + ] + }, + "CacheUsernameDownloadSettings": { + "description": "Settings for Extended Groups username and group download.", + "type": "object", + "properties": { + "extendedGroups": { + "type": "boolean", + "description": "Whether or not Extended Groups is enabled." + }, + "usernameSource": { + "description": "This setting determines how the cache gets username and group names for clients.", + "enum": [ + "AD", + "LDAP", + "File", + "None" + ], + "x-ms-enum": { + "name": "UsernameSource", + "modelAsString": true + }, + "type": "string", + "default": "None" + }, + "groupFileURI": { + "type": "string", + "description": "The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'." + }, + "userFileURI": { + "type": "string", + "description": "The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'." + }, + "ldapServer": { + "type": "string", + "description": "The fully qualified domain name or IP address of the LDAP server to use." + }, + "ldapBaseDN": { + "type": "string", + "description": "The base distinguished name for the LDAP domain." + }, + "encryptLdapConnection": { + "type": "boolean", + "description": "Whether or not the LDAP connection should be encrypted.", + "default": false + }, + "requireValidCertificate": { + "type": "boolean", + "description": "Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.", + "default": false + }, + "autoDownloadCertificate": { + "type": "boolean", + "description": "Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.", + "default": false + }, + "caCertificateURI": { + "type": "string", + "description": "The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true." + }, + "usernameDownloaded": { + "description": "Indicates whether or not the HPC Cache has performed the username download successfully.", + "type": "string", + "readOnly": true, + "enum": [ + "Yes", + "No", + "Error" + ], + "x-ms-enum": { + "name": "UsernameDownloadedType", + "modelAsString": true + } + }, + "credentials": { + "type": "object", + "description": "When present, these are the credentials for the secure LDAP connection.", + "properties": { + "bindDn": { + "type": "string", + "description": "The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "bindPassword": { + "type": "string", + "x-ms-secret": true, + "description": "The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response." + } + } + } + } + }, + "NfsAccessPolicy": { + "type": "object", + "description": "A set of rules describing access policies applied to NFSv3 clients of the cache.", + "properties": { + "name": { + "description": "Name identifying this policy. Access Policy names are not case sensitive.", + "type": "string" + }, + "accessRules": { + "description": "The set of rules describing client accesses allowed under this policy.", + "type": "array", + "items": { + "$ref": "#/definitions/NfsAccessRule" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name", + "accessRules" + ] + }, + "NfsAccessRule": { + "type": "object", + "description": "Rule to place restrictions on portions of the cache namespace being presented to clients.", + "properties": { + "scope": { + "description": "Scope for this rule. The scope and filter determine which clients match the rule.", + "type": "string", + "enum": [ + "default", + "network", + "host" + ], + "x-ms-enum": { + "name": "NfsAccessRuleScope", + "modelAsString": true + } + }, + "filter": { + "description": "Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied.", + "type": "string" + }, + "access": { + "description": "Access allowed by this rule.", + "type": "string", + "enum": [ + "no", + "ro", + "rw" + ], + "x-ms-enum": { + "name": "NfsAccessRuleAccess", + "modelAsString": true + } + }, + "suid": { + "description": "Allow SUID semantics.", + "type": "boolean" + }, + "submountAccess": { + "description": "For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'.", + "type": "boolean" + }, + "rootSquash": { + "description": "Map root accesses to anonymousUID and anonymousGID.", + "type": "boolean" + }, + "anonymousUID": { + "description": "UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided.", + "type": "string" + }, + "anonymousGID": { + "description": "GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided.", + "type": "string" + } + }, + "required": [ + "scope", + "access" + ] + }, + "KeyVaultKeyReference": { + "type": "object", + "description": "Describes a reference to key vault key.", + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in key vault." + }, + "sourceVault": { + "type": "object", + "description": "Describes a resource Id to source key vault.", + "properties": { + "id": { + "type": "string", + "description": "Resource Id." + } + } + } + }, + "required": [ + "keyUrl", + "sourceVault" + ] + }, + "CachesListResult": { + "description": "Result of the request to list caches. It contains a list of caches and a URL link to get the next set of results.", + "properties": { + "nextLink": { + "description": "URL to get the next set of cache list results, if there are any.", + "type": "string" + }, + "value": { + "description": "List of Caches.", + "items": { + "$ref": "#/definitions/Cache" + }, + "type": "array" + } + }, + "type": "object" + }, + "CacheHealth": { + "type": "object", + "description": "An indication of cache health. Gives more information about health than just that related to provisioning.", + "properties": { + "state": { + "description": "List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings.", + "enum": [ + "Unknown", + "Healthy", + "Degraded", + "Down", + "Transitioning", + "Stopping", + "Stopped", + "Upgrading", + "Flushing", + "WaitingForKey", + "StartFailed", + "UpgradeFailed" + ], + "x-ms-enum": { + "name": "HealthStateType", + "modelAsString": true + }, + "type": "string" + }, + "statusDescription": { + "description": "Describes explanation of state.", + "type": "string" + }, + "conditions": { + "description": "Outstanding conditions that need to be investigated and resolved.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Condition" + }, + "x-ms-identifiers": [] + } + } + }, + "Condition": { + "type": "object", + "description": "Outstanding conditions that will need to be resolved.", + "properties": { + "timestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the condition was raised." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The issue requiring attention." + } + } + }, + "CacheUpgradeStatus": { + "description": "Properties describing the software upgrade state of the cache.", + "properties": { + "currentFirmwareVersion": { + "description": "Version string of the firmware currently installed on this cache.", + "type": "string", + "readOnly": true + }, + "firmwareUpdateStatus": { + "description": "True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.", + "enum": [ + "available", + "unavailable" + ], + "x-ms-enum": { + "name": "FirmwareStatusType", + "modelAsString": true + }, + "readOnly": true, + "type": "string" + }, + "firmwareUpdateDeadline": { + "description": "Time at which the pending firmware update will automatically be installed on the cache.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastFirmwareUpdate": { + "description": "Time of the last successful firmware update.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "pendingFirmwareVersion": { + "description": "When firmwareUpdateAvailable is true, this field holds the version string for the update.", + "type": "string", + "readOnly": true + } + }, + "type": "object" + }, + "CacheUpgradeSettings": { + "description": "Cache Upgrade Settings.", + "properties": { + "upgradeScheduleEnabled": { + "description": "True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.", + "type": "boolean" + }, + "scheduledTime": { + "description": "When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "UnknownProperties": { + "description": "Properties of an unknown type of Storage Target.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "StorageTarget": { + "type": "object", + "description": "Type of the Storage Target.", + "allOf": [ + { + "$ref": "#/definitions/StorageTargetResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "StorageTarget properties", + "$ref": "#/definitions/StorageTargetProperties" + } + } + }, + "StorageTargetResource": { + "type": "object", + "description": "Resource used by a cache.", + "properties": { + "name": { + "description": "Name of the Storage Target.", + "readOnly": true, + "$ref": "#/definitions/ResourceName" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID of the Storage Target." + }, + "type": { + "description": "Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget", + "readOnly": true, + "type": "string" + }, + "location": { + "description": "Region name string.", + "readOnly": true, + "type": "string" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "x-ms-azure-resource": true + }, + "StorageTargetProperties": { + "type": "object", + "description": "Properties of the Storage Target.", + "required": [ + "targetType" + ], + "properties": { + "junctions": { + "description": "List of cache namespace junctions to target for namespace associations.", + "type": "array", + "items": { + "$ref": "#/definitions/NamespaceJunction" + }, + "x-ms-identifiers": [] + }, + "targetType": { + "description": "Type of the Storage Target.", + "enum": [ + "nfs3", + "clfs", + "unknown", + "blobNfs" + ], + "x-ms-enum": { + "name": "StorageTargetType", + "modelAsString": true + }, + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningStateType", + "modelAsString": true + }, + "type": "string", + "readOnly": true + }, + "state": { + "description": "Storage target operational state.", + "enum": [ + "Ready", + "Busy", + "Suspended", + "Flushing" + ], + "x-ms-enum": { + "name": "OperationalStateType", + "modelAsString": true + }, + "type": "string" + }, + "nfs3": { + "description": "Properties when targetType is nfs3.", + "$ref": "#/definitions/Nfs3Target" + }, + "clfs": { + "description": "Properties when targetType is clfs.", + "$ref": "#/definitions/ClfsTarget" + }, + "unknown": { + "description": "Properties when targetType is unknown.", + "$ref": "#/definitions/UnknownTarget" + }, + "blobNfs": { + "description": "Properties when targetType is blobNfs.", + "$ref": "#/definitions/BlobNfsTarget" + }, + "allocationPercentage": { + "description": "The percentage of cache space allocated for this storage target", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "readOnly": true + } + } + }, + "Nfs3Target": { + "type": "object", + "description": "Properties pertaining to the Nfs3Target", + "properties": { + "target": { + "description": "IP address or host name of an NFSv3 host (e.g., 10.0.44.44).", + "pattern": "^[-.,0-9a-zA-Z]+$", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "usageModel": { + "description": "Identifies the StorageCache usage model to be used for this storage target.", + "type": "string" + }, + "verificationTimer": { + "description": "Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates.", + "type": "integer", + "format": "int32" + }, + "writeBackTimer": { + "description": "Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage.", + "type": "integer", + "format": "int32" + } + } + }, + "ClfsTarget": { + "type": "object", + "description": "Properties pertaining to the ClfsTarget", + "properties": { + "target": { + "description": "Resource ID of storage container.", + "$ref": "#/definitions/URLString", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "UnknownTarget": { + "type": "object", + "description": "Properties pertaining to the UnknownTarget", + "properties": { + "attributes": { + "description": "Dictionary of string->string pairs containing information about the Storage Target.", + "$ref": "#/definitions/UnknownProperties" + } + } + }, + "BlobNfsTarget": { + "type": "object", + "description": "Properties pertaining to the BlobNfsTarget.", + "properties": { + "target": { + "description": "Resource ID of the storage container.", + "$ref": "#/definitions/URLString", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "usageModel": { + "description": "Identifies the StorageCache usage model to be used for this storage target.", + "type": "string" + }, + "verificationTimer": { + "description": "Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates.", + "type": "integer", + "format": "int32" + }, + "writeBackTimer": { + "description": "Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage.", + "type": "integer", + "format": "int32" + } + } + }, + "ResourceName": { + "description": "Schema for the name of resources served by this provider. Note that objects will contain an odata @id annotation as appropriate. This will contain the complete resource id of the object. These names are case-preserving, but not case sensitive.", + "pattern": "^[-0-9a-zA-Z_]{1,80}$", + "type": "string" + }, + "ResourceSku": { + "description": "A resource SKU.", + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "capabilities": { + "description": "A list of capabilities of this SKU, such as throughput or ops/sec.", + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + }, + "type": "array", + "x-ms-identifiers": [ + "name" + ] + }, + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations where the SKU is available. This is the supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.)." + }, + "locationInfo": { + "description": "The set of locations where the SKU is available.", + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "name": { + "description": "The name of this SKU.", + "type": "string" + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Restriction" + }, + "description": "The restrictions preventing this SKU from being used. This is empty if there are no restrictions.", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "Restriction": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The type of restrictions. In this version, the only possible value for this is location." + }, + "values": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location, then this would be the different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ReasonCode", + "modelAsString": true + }, + "description": "The reason for the restriction. As of now this can be \"QuotaId\" or \"NotAvailableForSubscription\". \"QuotaId\" is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. \"NotAvailableForSubscription\" is related to capacity at the datacenter." + } + }, + "description": "The restrictions preventing this SKU from being used." + }, + "ResourceSkuCapabilities": { + "description": "A resource SKU capability.", + "properties": { + "name": { + "description": "Name of a capability, such as ops/sec.", + "type": "string" + }, + "value": { + "description": "Quantity, if the capability is measured by quantity.", + "type": "string" + } + }, + "type": "object" + }, + "ResourceSkuLocationInfo": { + "description": "Resource SKU location information.", + "properties": { + "location": { + "description": "Location where this SKU is available.", + "type": "string" + }, + "zones": { + "description": "Zones if any.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" + }, + "ResourceSkusResult": { + "type": "object", + "description": "The response from the List Cache SKUs operation.", + "properties": { + "nextLink": { + "description": "The URI to fetch the next page of cache SKUs.", + "type": "string" + }, + "value": { + "description": "The list of SKUs available for the subscription.", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSku" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "NamespaceJunction": { + "description": "A namespace junction.", + "type": "object", + "properties": { + "namespacePath": { + "description": "Namespace path on a cache for a Storage Target.", + "type": "string" + }, + "targetPath": { + "description": "Path in Storage Target to which namespacePath points.", + "type": "string" + }, + "nfsExport": { + "description": "NFS export where targetPath exists.", + "type": "string" + }, + "nfsAccessPolicy": { + "description": "Name of the access policy applied to this junction.", + "type": "string", + "default": "default" + } + } + }, + "StorageTargetsResult": { + "description": "A list of Storage Targets.", + "properties": { + "nextLink": { + "description": "The URI to fetch the next page of Storage Targets.", + "type": "string" + }, + "value": { + "description": "The list of Storage Targets defined for the cache.", + "items": { + "$ref": "#/definitions/StorageTarget" + }, + "type": "array" + } + }, + "type": "object" + }, + "URLString": { + "description": "A fully qualified URL.", + "type": "string" + }, + "UsageModel": { + "description": "A usage model.", + "properties": { + "display": { + "description": "Localized information describing this usage model.", + "type": "object", + "properties": { + "description": { + "description": "String to display for this usage model.", + "type": "string" + } + } + }, + "modelName": { + "description": "Non-localized keyword name for this usage model.", + "type": "string" + }, + "targetType": { + "description": "The type of Storage Target to which this model is applicable (only nfs3 as of this version).", + "type": "string" + } + }, + "type": "object" + }, + "UsageModelsResult": { + "description": "A list of cache usage models.", + "properties": { + "nextLink": { + "description": "The URI to fetch the next page of cache usage models.", + "type": "string" + }, + "value": { + "description": "The list of usage models available for the subscription.", + "items": { + "$ref": "#/definitions/UsageModel" + }, + "type": "array", + "x-ms-identifiers": [ + "modelName" + ] + } + }, + "type": "object" + }, + "ResourceUsagesListResult": { + "description": "Result of the request to list resource usages. It contains a list of resource usages & limits and a URL link to get the next set of results.", + "properties": { + "nextLink": { + "description": "URL to get the next set of resource usage list results if there are any.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "List of usages and limits for resources controlled by the Microsoft.StorageCache resource provider.", + "items": { + "$ref": "#/definitions/ResourceUsage" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [ + "name" + ] + } + }, + "type": "object" + }, + "ResourceUsage": { + "description": "The usage and limit (quota) for a resource.", + "properties": { + "limit": { + "description": "The limit (quota) for this resource.", + "readOnly": true, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "unit": { + "description": "Unit that the limit and usages are expressed in, such as 'Count'.", + "readOnly": true, + "type": "string" + }, + "currentValue": { + "description": "The current usage of this resource.", + "readOnly": true, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "name": { + "description": "Naming information for this resource type.", + "readOnly": true, + "type": "object", + "properties": { + "value": { + "description": "Canonical name for this resource type.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name for this resource type.", + "type": "string" + } + } + } + }, + "type": "object" + }, + "MetricSpecification": { + "type": "object", + "description": "Details about operation related to metrics.", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "Localized display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "The description of the metric." + }, + "unit": { + "type": "string", + "description": "The unit that the metric is measured in." + }, + "aggregationType": { + "type": "string", + "description": "The type of metric aggregation." + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "type": "array", + "items": { + "enum": [ + "NotSpecified", + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + }, + "metricClass": { + "description": "Type of metrics.", + "type": "string" + }, + "dimensions": { + "description": "Dimensions of the metric", + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "x-ms-identifiers": [] + } + } + }, + "LogSpecification": { + "type": "object", + "description": "Details about operation related to logs.", + "properties": { + "name": { + "type": "string", + "description": "The name of the log." + }, + "displayName": { + "type": "string", + "description": "Localized display name of the log." + } + } + }, + "MetricDimension": { + "type": "object", + "description": "Specifications of the Dimension of metrics.", + "properties": { + "name": { + "type": "string", + "description": "Name of the dimension" + }, + "displayName": { + "type": "string", + "description": "Localized friendly display name of the dimension" + }, + "internalName": { + "type": "string", + "description": "Internal name of the dimension." + }, + "toBeExportedForShoebox": { + "description": "To be exported to shoe box.", + "type": "boolean" + } + } + }, + "PrimingJob": { + "description": "A priming job instance.", + "properties": { + "primingJobName": { + "description": "The priming job name.", + "$ref": "#/definitions/ResourceName", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "primingManifestUrl": { + "description": "The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "primingJobId": { + "description": "The unique identifier of the priming job.", + "pattern": "^[-0-9a-zA-Z_]{1,80}$", + "readOnly": true, + "type": "string" + }, + "primingJobState": { + "description": "The state of the priming operation.", + "enum": [ + "Queued", + "Running", + "Paused", + "Complete" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "PrimingJobState", + "modelAsString": true + } + }, + "primingJobStatus": { + "description": "The status code of the priming job.", + "type": "string", + "readOnly": true + }, + "primingJobDetails": { + "description": "The job details or error information if any.", + "type": "string", + "readOnly": true + }, + "primingJobPercentComplete": { + "description": "The current progress of the priming job, as a percentage.", + "type": "number", + "format": "double", + "maximum": 100, + "minimum": 0, + "readOnly": true + } + }, + "required": [ + "primingJobName", + "primingManifestUrl" + ], + "type": "object" + }, + "PrimingJobList": { + "description": "The list of priming jobs defined for the cache.", + "items": { + "$ref": "#/definitions/PrimingJob" + }, + "type": "array", + "x-ms-identifiers": [ + "primingJobId" + ], + "readOnly": true + }, + "PrimingJobIdParameter": { + "description": "Object containing the priming job ID.", + "properties": { + "primingJobId": { + "description": "The unique identifier of the priming job.", + "pattern": "^[-0-9a-zA-Z_]{1,80}$", + "type": "string" + } + }, + "required": [ + "primingJobId" + ], + "type": "object" + }, + "SpaceAllocationList": { + "description": "List of storage target space allocations.", + "items": { + "$ref": "#/definitions/StorageTargetSpaceAllocation" + }, + "type": "array", + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "SpaceAllocationParameter": { + "description": "List of storage target space allocations.", + "items": { + "$ref": "#/definitions/StorageTargetSpaceAllocation" + }, + "type": "array", + "x-ms-identifiers": [ + "name" + ] + }, + "StorageTargetSpaceAllocation": { + "description": "Storage Target space allocation properties.", + "properties": { + "name": { + "description": "Name of the storage target.", + "$ref": "#/definitions/ResourceName" + }, + "allocationPercentage": { + "description": "The percentage of cache space allocated for this storage target", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100 + } + }, + "type": "object" + } + }, + "parameters": { + "CacheNameParameter": { + "description": "Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.", + "in": "path", + "name": "cacheName", + "pattern": "^[-0-9a-zA-Z_]{1,80}$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "StorageTargetParameter": { + "description": "Name of Storage Target.", + "in": "path", + "name": "storageTargetName", + "pattern": "^[-0-9a-zA-Z_]{1,80}$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/storagecache/resource-manager/readme.md b/specification/storagecache/resource-manager/readme.md index b4c0a99229c7..d3f51a2b3fd0 100644 --- a/specification/storagecache/resource-manager/readme.md +++ b/specification/storagecache/resource-manager/readme.md @@ -26,21 +26,31 @@ These are the global settings for the StorageCache API. ``` yaml openapi-type: arm -tag: package-2023-05 +tag: package-preview-2023-11 add-credentials: true title: StorageCacheManagementClient ``` +### Tag: package-preview-2023-11 + +These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-11' +input-file: + - Microsoft.StorageCache/preview/2023-11-01-preview/amlfilesystem.json + - Microsoft.StorageCache/preview/2023-11-01-preview/storagecache.json +``` ### Tag: package-2023-05 These settings apply only when `--tag=package-2023-05` is specified on the command line. -```yaml $(tag) == 'package-2023-05' +``` yaml $(tag) == 'package-2023-05' input-file: - Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json - Microsoft.StorageCache/stable/2023-05-01/storagecache.json ``` + ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json index b518534e8a1d..b4f12e4f491b 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json @@ -433,8 +433,7 @@ "cacheSize": { "type": "integer", "format": "int32", - "description": "The cache size", - "readOnly": true + "description": "The cache size" }, "dynamicExecutorAllocation": { "$ref": "#/definitions/DynamicExecutorAllocation", diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/bigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/bigDataPool.json index 4a67d7cacfdd..92367b18a593 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/bigDataPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/bigDataPool.json @@ -433,8 +433,7 @@ "cacheSize": { "type": "integer", "format": "int32", - "description": "The cache size", - "readOnly": true + "description": "The cache size" }, "dynamicExecutorAllocation": { "$ref": "#/definitions/DynamicExecutorAllocation", diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json new file mode 100644 index 000000000000..1c928122ab80 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json @@ -0,0 +1,375 @@ +{ + "swagger": "2.0", + "info": { + "title": "Test Base", + "description": "Restful APIs for Test Base Action Requests.", + "version": "2023-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/actionRequests/{actionRequestName}": { + "get": { + "tags": [ + "Test Base Action Requests" + ], + "operationId": "ActionRequests_Get", + "description": "Get the action request under the specified test base account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ActionRequestName" + } + ], + "responses": { + "200": { + "description": "Succeeded to get the action request under the specified test base account.", + "schema": { + "$ref": "#/definitions/ActionRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ActionRequestGet": { + "$ref": "./examples/ActionRequestGet.json" + } + } + }, + "put": { + "tags": [ + "Test Base Action Requests" + ], + "operationId": "ActionRequests_Put", + "description": "Create (submit) an action request.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/ActionRequestName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "actionRequest", + "schema": { + "$ref": "#/definitions/ActionRequest" + } + } + ], + "responses": { + "200": { + "description": "Succeeded to update an action request.", + "schema": { + "$ref": "#/definitions/ActionRequest" + } + }, + "201": { + "description": "Succeeded to create (submit) an action request.", + "schema": { + "$ref": "#/definitions/ActionRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ActionRequestPut": { + "$ref": "./examples/ActionRequestPut.json" + } + } + }, + "delete": { + "tags": [ + "Test Base Action Requests" + ], + "operationId": "ActionRequests_Delete", + "description": "Delete (revoke) an action request. Only requests in review can be deleted.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/ActionRequestName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succeeded to delete the specified action request." + }, + "204": { + "description": "Succeeded to delete the specified action request." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ActionRequestDelete": { + "$ref": "./examples/ActionRequestDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/actionRequests": { + "get": { + "tags": [ + "Test Base Action Requests" + ], + "operationId": "ActionRequests_List", + "description": "List all action requests under the specified test base account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RequestTypeFilter" + }, + { + "$ref": "./testbase.json#/parameters/TopFilter" + } + ], + "responses": { + "200": { + "description": "Succeeded to list all action requests under the specified test base account.", + "schema": { + "$ref": "#/definitions/ActionRequests" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ActionRequestList": { + "$ref": "./examples/ActionRequestList.json" + } + } + } + } + }, + "definitions": { + "ActionRequests": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ActionRequest" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "ActionRequest": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ActionRequestProperties", + "x-ms-client-flatten": true, + "description": "Test Base Draft Package properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ActionRequestProperties": { + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "./testbase.json#/definitions/ProvisioningState" + }, + "requestType": { + "$ref": "#/definitions/RequestTypes" + }, + "preReleaseAccessRequestSpec": { + "$ref": "#/definitions/PreReleaseAccessRequestSpec" + }, + "creationDate": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "status": { + "type": "string", + "enum": [ + "InReview", + "Approved", + "Declined" + ], + "x-ms-enum": { + "name": "requestStatus", + "modelAsString": true + }, + "readOnly": true + } + }, + "required": [ + "requestType" + ] + }, + "RequestTypes": { + "type": "string", + "enum": [ + "PreReleaseAccess" + ], + "x-ms-enum": { + "name": "requestTypes", + "modelAsString": true + } + }, + "PreReleaseAccessRequestSpec": { + "type": "object", + "properties": { + "organizationName": { + "type": "string" + }, + "email": { + "type": "string" + }, + "engagements": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "MVI", + "MVP", + "SUVP", + "MAPP", + "Other" + ], + "x-ms-enum": { + "name": "engagements", + "modelAsString": true + } + } + }, + "streetAddress": { + "type": "string" + }, + "city": { + "type": "string" + }, + "stateOrProvince": { + "type": "string" + }, + "zipCode": { + "type": "string" + }, + "countryAndRegion": { + "type": "string" + }, + "companyWebsite": { + "type": "string" + } + } + } + }, + "parameters": { + "ActionRequestName": { + "name": "actionRequestName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9_]|([-. ][A-Za-z0-9]))+$" + }, + "RequestTypeFilter": { + "name": "requestType", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/chat.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/chat.json new file mode 100644 index 000000000000..dcfe6aebd3e0 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/chat.json @@ -0,0 +1,350 @@ +{ + "swagger": "2.0", + "info": { + "title": "Test Base", + "description": "Test Base", + "version": "2023-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/chatSessions": { + "get": { + "tags": [ + "Chat" + ], + "operationId": "ChatSessions_List", + "description": "List all chat sessions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The chat session was successfully created.", + "schema": { + "$ref": "#/definitions/ChatSessionResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ChatSessionList": { + "$ref": "./examples/ChatSessionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/chatSessions/{chatSessionName}": { + "get": { + "tags": [ + "Chat" + ], + "operationId": "ChatSessions_Get", + "description": "Get a chat session", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/ChatSessionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The chat session.", + "schema": { + "$ref": "#/definitions/ChatSessionResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ChatSessionGet": { + "$ref": "./examples/ChatSessionGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/chatSessions/{chatSessionName}/chat": { + "post": { + "tags": [ + "Chat" + ], + "operationId": "ChatSession_Chat", + "description": "Start a new chat turn. Ask a question and see the answer in response.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/ChatSessionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ChatRequest" + }, + "description": "Payload to ask a question." + } + ], + "responses": { + "200": { + "description": "The question was answered.", + "schema": { + "$ref": "#/definitions/ChatResponse" + } + }, + "202": { + "description": "The chat operation was successfully enqueued. Waiting for the answer.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "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-examples": { + "ChatSessionChat": { + "$ref": "./examples/ChatSessionChat.json" + } + } + } + } + }, + "definitions": { + "ChatSessionResourceListResult": { + "description": "A list of chat session.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ChatSessionResource" + }, + "description": "The list of chat session." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "ChatSessionResource": { + "type": "object", + "description": "The chat session resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ChatSessionProperties", + "description": "The properties of chat session." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ChatSessionProperties": { + "type": "object", + "description": "The chat session properties.", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "./testbase.json#/definitions/ProvisioningState" + } + } + }, + "ChatRequest": { + "type": "object", + "description": "The chat request payload.", + "properties": { + "question": { + "type": "string", + "description": "The question of the chat turn" + } + }, + "required": [ + "question" + ] + }, + "ChatResponse": { + "type": "object", + "description": "The chat response payload.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ChatResponseProperties", + "description": "The properties of chat response." + } + }, + "required": [ + "properties" + ] + }, + "ChatResponseProperties": { + "type": "object", + "description": "The chat response properties.", + "properties": { + "question": { + "type": "string", + "description": "The question from the request" + }, + "answer": { + "type": "string", + "description": "The answer from the system" + }, + "citations": { + "type": "array", + "items": { + "$ref": "#/definitions/AnswerCitation" + }, + "x-ms-identifiers": [] + }, + "usage": { + "type": "integer", + "format": "int32", + "description": "The usage of questions within the chat session", + "readOnly": true + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "The limit of questions within the chat session", + "readOnly": true + } + }, + "required": [ + "question", + "answer", + "usage", + "limit" + ] + }, + "AnswerCitation": { + "type": "object", + "description": "The answer citation.", + "properties": { + "title": { + "type": "string", + "description": "The title of the citation." + }, + "url": { + "type": "string", + "description": "The url of the citation." + }, + "chunkIndex": { + "type": "integer", + "description": "The chunk index of the content.", + "format": "int32" + } + } + } + }, + "parameters": { + "ChatSessionNameParameter": { + "name": "chatSessionName", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9_]|([-. ][A-Za-z0-9]))+$", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The chat session name." + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/credential.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/credential.json new file mode 100644 index 000000000000..da70e6396116 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/credential.json @@ -0,0 +1,380 @@ +{ + "swagger": "2.0", + "info": { + "title": "Test Base", + "description": "Use these REST APIs for Test Base Credential controls.", + "version": "2023-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/credentials": { + "get": { + "tags": [ + "Test Base Credential" + ], + "operationId": "Credential_ListByTestBaseAccount", + "description": "Lists all the Credentials under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/CredentialListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CustomImagesList": { + "$ref": "./examples/CredentialsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/credentials/{credentialName}": { + "put": { + "tags": [ + "Test Base Credential" + ], + "operationId": "Credentials_Create", + "description": "Creates or replaces a Test Base Credential.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CredentialResource" + }, + "description": "Parameters supplied to create a Test Base Credential." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CredentialNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The test base credential was successfully created or updated.", + "schema": { + "$ref": "#/definitions/CredentialResource" + } + }, + "201": { + "description": "Create a test base credential Resource.", + "schema": { + "$ref": "#/definitions/CredentialResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitionCreate": { + "$ref": "./examples/CredentialCreate.json" + } + } + }, + "patch": { + "tags": [ + "Test Base Credential" + ], + "operationId": "Credentials_Update", + "description": "Updates an existing test base credential.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CredentialResource" + }, + "description": "Parameters supplied to create a test base credential." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CredentialNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Get the test base credential.", + "schema": { + "$ref": "#/definitions/CredentialResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CredentialUpdate": { + "$ref": "./examples/CredentialUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Test Base Credential" + ], + "operationId": "Credentials_Delete", + "description": "Deletes an existing test base credential.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CredentialNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The test base credential was deleted successfully." + }, + "204": { + "description": "The test base credential was deleted successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DraftPackageDelete": { + "$ref": "./examples/CredentialDelete.json" + } + } + }, + "get": { + "tags": [ + "Test Base Credential" + ], + "operationId": "Credential_Get", + "description": "Gets a test base credential Resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CredentialNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Get the test base Credential.", + "schema": { + "$ref": "#/definitions/CredentialResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CredentialGet": { + "$ref": "./examples/CredentialGet.json" + } + } + } + } + }, + "definitions": { + "CredentialListResult": { + "description": "A list of credential resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CredentialResource" + }, + "description": "The list of credential resources." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "CredentialResource": { + "description": "The test base credential resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CredentialProperties", + "x-ms-client-flatten": true, + "description": "The test base credential properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "CredentialProperties": { + "description": "The properties of test base credential", + "discriminator": "credentialType", + "type": "object", + "properties": { + "credentialType": { + "type": "string", + "description": "Credential type.", + "enum": [ + "IntuneAccount" + ], + "x-ms-enum": { + "name": "CredentialType", + "modelAsString": true, + "values": [ + { + "value": "IntuneAccount", + "description": "Username password credential for intune enrollment." + } + ] + } + }, + "displayName": { + "type": "string", + "description": "Credential display name." + } + }, + "required": [ + "credentialType", + "displayName" + ] + }, + "IntuneSingletonResourceProperties": { + "description": "The properties of intune credential.", + "type": "object", + "x-ms-discriminator-value": "IntuneAccount", + "properties": { + "userNameKeyVaultSecretPath": { + "type": "string", + "description": "The key vault secret path of user name." + }, + "passwordKeyVaultSecretPath": { + "type": "string", + "description": "The key vault secret path of password." + } + }, + "allOf": [ + { + "$ref": "#/definitions/CredentialProperties" + } + ] + } + }, + "parameters": { + "CredentialNameParameter": { + "name": "credentialName", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9_]|([-. ][A-Za-z0-9]))+$", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The credential resource name." + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/customimage.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/customimage.json new file mode 100644 index 000000000000..3cb001d89f1a --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/customimage.json @@ -0,0 +1,1131 @@ +{ + "swagger": "2.0", + "info": { + "title": "Test Base", + "description": "Use these REST APIs for Test Base Custom Image controls.", + "version": "2023-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/customImages": { + "get": { + "tags": [ + "Test Base Custom Image" + ], + "operationId": "CustomImages_ListByTestBaseAccount", + "description": "Lists all the custom images under a test base account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/CustomImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CustomImagesList": { + "$ref": "./examples/CustomImagesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/customImages/{customImageName}": { + "put": { + "tags": [ + "Test Base Custom Image" + ], + "operationId": "CustomImages_Create", + "description": "Creates a test base custom image.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CustomImageResource" + }, + "description": "Parameters supplied to create a test base custom image." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CustomImageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The test base custom image was successfully created or updated.", + "schema": { + "$ref": "#/definitions/CustomImageResource" + } + }, + "201": { + "description": "The test base custom image 'create' operation was successfully enqueued. Check provisioningState to track execution status.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomImageResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomImageCreate": { + "$ref": "./examples/CustomImageCreate.json" + } + } + }, + "delete": { + "tags": [ + "Test Base Custom Image" + ], + "operationId": "CustomImages_Delete", + "description": "Deletes a test base custom image.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CustomImageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The test base custom image 'delete' operation was successfully enqueued. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "The test base custom image was deleted successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomImageDelete": { + "$ref": "./examples/CustomImageDelete.json" + } + } + }, + "get": { + "tags": [ + "Test Base Custom Image" + ], + "operationId": "CustomImages_Get", + "description": "Gets a test base custom image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CustomImageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The test base custom image was successfully found.", + "schema": { + "$ref": "#/definitions/CustomImageResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomImageGet": { + "$ref": "./examples/CustomImageGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/checkImageNameAvailability": { + "post": { + "tags": [ + "Test Base Custom Image" + ], + "operationId": "CustomImages_CheckImageNameAvailability", + "description": "Checks that the test vase custom image generated from VHD resource has valid and unique definition and version, return architecture and OS state of potential existing image definition.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageNameCheckAvailabilityParameters" + }, + "description": "Parameters supplied to the test base custom image CheckAvailability operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Image definition and version is available.", + "schema": { + "$ref": "#/definitions/CheckImageAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckImageAvailability": { + "$ref": "./examples/CheckImageNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/imageDefinitions": { + "get": { + "tags": [ + "Test Base Image Definition // Reminder: Need renaming." + ], + "operationId": "ImageDefinitions_ListByTestBaseAccount", + "description": "List all image definition properties created by test base custom images which are derived from 'VHD' source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Get image definition existence and get detailed properties if applicable.", + "schema": { + "$ref": "#/definitions/ImageDefinitionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListImageDefinitions": { + "$ref": "./examples/ImageDefinitionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/imageDefinitions/{imageDefinitionName}": { + "put": { + "tags": [ + "Test Base Image Definition" + ], + "operationId": "ImageDefinitions_Create", + "description": "Create image definition for test base custom images which are derived from 'VHD' source.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageDefinitionResource" + }, + "description": "Parameters supplied to create a test base image definition." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The test base image definition Resource has been successfully created or updated.", + "schema": { + "$ref": "#/definitions/ImageDefinitionResource" + } + }, + "201": { + "description": "Create a test base image definition resource.", + "schema": { + "$ref": "#/definitions/ImageDefinitionResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitionCreate": { + "$ref": "./examples/ImageDefinitionCreate.json" + } + } + }, + "get": { + "tags": [ + "Test Base ImageDefinition" + ], + "operationId": "ImageDefinitions_Get", + "description": "Get image properties under the image definition name created by test base custom image which derived from 'VHD' source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Get the detailed properties of the image definition if applicable.", + "schema": { + "$ref": "#/definitions/ImageDefinitionResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitionGet": { + "$ref": "./examples/ImageDefinitionGet.json" + } + } + }, + "delete": { + "tags": [ + "Test Base Image Definition" + ], + "operationId": "ImageDefinitions_Delete", + "description": "Delete a test base image definition resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The test base image definition was deleted successfully." + }, + "204": { + "description": "The test base image definition was deleted successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitionDelete": { + "$ref": "./examples/ImageDefinitionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/vhds": { + "get": { + "tags": [ + "Test Base VHD" + ], + "operationId": "VHDs_ListByTestBaseAccount", + "description": "Lists all the VHDs under a test base account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/VHDListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VHDsList": { + "$ref": "./examples/VHDsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/vhds/{vhdName}": { + "delete": { + "tags": [ + "Test Base VHD" + ], + "operationId": "VHDs_Delete", + "description": "Deletes a Test Base VHD.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/VhdNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The test base VHD was deleted successfully." + }, + "204": { + "description": "The test base VHD was deleted successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VHDDelete": { + "$ref": "./examples/VHDDelete.json" + } + } + }, + "get": { + "tags": [ + "Test Base VHD" + ], + "operationId": "VHDs_Get", + "description": "Gets a Test Base VHD.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/VhdNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base VHD was successfully found.", + "schema": { + "$ref": "#/definitions/VHDResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VHDGet": { + "$ref": "./examples/VHDGet.json" + } + } + } + } + }, + "definitions": { + "CustomImageListResult": { + "description": "A list of Test Base custom images.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomImageResource" + }, + "description": "The list of Test Base custom images." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "CustomImageResource": { + "description": "The test base custom image resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CustomImageProperties", + "x-ms-client-flatten": true, + "description": "Test Base custom image properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "CustomImageProperties": { + "description": "The properties of the test base custom image.", + "type": "object", + "properties": { + "vhdId": { + "type": "string", + "description": "The Id of the associated VHD resource." + }, + "definitionName": { + "type": "string", + "description": "Image definition name." + }, + "versionName": { + "type": "string", + "description": "Image version name." + }, + "source": { + "type": "string", + "description": "Custom image source type.", + "default": "VHD", + "enum": [ + "Unknown", + "VHD" + ], + "x-ms-enum": { + "name": "ImageSource", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Unknown image source type." + }, + { + "value": "VHD", + "description": "Specify image onboarding through VHD." + } + ] + } + }, + "product": { + "type": "string", + "description": "Product of the custom image.", + "readOnly": true + }, + "release": { + "type": "string", + "description": "Release of the custom image OS.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Status of the custom image.", + "readOnly": true, + "enum": [ + "Unknown", + "Ready", + "Failed", + "Validating" + ], + "x-ms-enum": { + "name": "ImageStatus", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Unknown image status." + }, + { + "value": "Ready", + "description": "Completed validation and is ready for use." + }, + { + "value": "Failed", + "description": "Failed to onboard or pass validation." + }, + { + "value": "Validating", + "description": "Succeed to onboard but is in validation process." + } + ] + } + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp when the custom image was published.", + "readOnly": true + }, + "validationResults": { + "$ref": "#/definitions/ImageValidationResults", + "description": "The validation result of the custom image.", + "readOnly": true + }, + "osDiskImageSizeInGB": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "This property indicates the size of the VHD to be created." + }, + "releaseVersionDate": { + "type": "string", + "format": "date-time", + "description": "The release version date of the release of the custom image OS.", + "readOnly": true + }, + "vhdFileName": { + "type": "string", + "description": "The file name of the associated VHD resource.", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "./testbase.json#/definitions/ProvisioningState" + } + }, + "required": [ + "definitionName", + "versionName", + "source" + ] + }, + "ImageDefinitionListResult": { + "description": "A list of test base image definitions.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinitionResource" + }, + "description": "The list of test base image definitions." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "ImageDefinitionResource": { + "description": "The test base image definition resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ImageDefinitionProperties", + "x-ms-client-flatten": true, + "description": "Test Base custom image properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ImageDefinitionProperties": { + "description": "The image properties under the image definition name.", + "type": "object", + "properties": { + "architecture": { + "description": "Custom image architecture.", + "type": "string", + "enum": [ + "x64" + ], + "x-ms-enum": { + "name": "ImageArchitecture", + "modelAsString": true, + "values": [ + { + "value": "x64", + "description": "64-bit architecture." + } + ] + } + }, + "osState": { + "description": "Custom image OS state.", + "type": "string", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "ImageOSState", + "modelAsString": true, + "values": [ + { + "value": "Generalized", + "description": "Sysprep generalization processed." + }, + { + "value": "Specialized", + "description": "Fully kept with user specified settings." + } + ] + } + }, + "securityType": { + "description": "Custom image security type.", + "type": "string", + "enum": [ + "Standard", + "TrustedLaunch" + ], + "x-ms-enum": { + "name": "ImageSecurityType", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard security type." + }, + { + "value": "TrustedLaunch", + "description": "Specify higher security level compared to Standard." + } + ] + } + }, + "provisioningState": { + "type": "string", + "readOnly": true + } + }, + "required": [ + "architecture", + "osState", + "securityType" + ] + }, + "ImageValidationResults": { + "description": "The image validation result.", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/VerificationResult" + }, + "x-ms-identifiers": [], + "description": "The validation results of the image." + } + } + }, + "VerificationResult": { + "description": "The detailed result of a validation or rule checking.", + "type": "object", + "properties": { + "verificationName": { + "type": "string", + "description": "The name of the verification rule." + }, + "result": { + "type": "string", + "enum": [ + "Passed", + "Failed" + ], + "description": "Indicates if the validation or rule checking is passed.", + "x-ms-enum": { + "name": "VerificationStatus", + "modelAsString": true, + "values": [ + { + "value": "Passed", + "description": "Validation or rule checking passed." + }, + { + "value": "Failed", + "description": "Validation or rule checking failed." + } + ] + } + }, + "message": { + "type": "string", + "description": "Message for clarification." + } + }, + "required": [ + "result" + ] + }, + "ImageNameCheckAvailabilityParameters": { + "description": "Parameter body to request test base custom image availability.", + "type": "object", + "properties": { + "definitionName": { + "type": "string", + "description": "Image definition name." + }, + "versionName": { + "type": "string", + "description": "Image version name." + } + }, + "required": [ + "definitionName", + "versionName" + ] + }, + "CheckImageAvailabilityResult": { + "$ref": "#/definitions/VerificationResult", + "description": "The image availability result." + }, + "GetImageDefinitionParameters": { + "description": "Parameters supplied to get the test base custom image Definition operation.", + "type": "object", + "properties": { + "definitionName": { + "type": "string", + "description": "Image definition name." + } + } + }, + "ImageDefinitionsListResult": { + "description": "The result of all available image definition under a test base account.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinitionResource" + }, + "description": "The list of image definitions." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "VHDListResult": { + "description": "A list of VHD resource.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VHDResource" + }, + "description": "The list of Test Base VHDs." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "VHDResource": { + "description": "The Test Base VHD resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/VHDProperties", + "x-ms-client-flatten": true, + "description": "The Test Base VHD validation result properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VHDProperties": { + "description": "The Test Base VHD properties", + "type": "object", + "properties": { + "path": { + "type": "string", + "readOnly": true, + "description": "The relative path of the VHD file." + }, + "fileName": { + "type": "string", + "readOnly": true, + "description": "The VHD file name." + }, + "fileSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The file size in bytes of the VHD file." + }, + "status": { + "type": "string", + "description": "The status of the VHD.", + "readOnly": true, + "enum": [ + "Unknown", + "Ready", + "Failed", + "Verifying", + "Occupied" + ], + "x-ms-enum": { + "name": "VHDStatus", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Unknown VHD status." + }, + { + "value": "Ready", + "description": "Succeed to be upload and pass VHD verification." + }, + { + "value": "Failed", + "description": "Failed to pass VHD verification." + }, + { + "value": "Verifying", + "description": "Processing VHD file checking and malware scanning." + }, + { + "value": "Occupied", + "description": "An image is onboarding with this VHD." + } + ] + } + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp when the VHD was created.", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "CustomImageNameParameter": { + "name": "customImageName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of the test base custom image.", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9_]|([-. ][A-Za-z0-9]))+$" + }, + "ImageDefinitionNameParameter": { + "name": "imageDefinitionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of the test base image definition.", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9_]|([-. ][A-Za-z0-9]))+$" + }, + "VhdNameParameter": { + "name": "vhdName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of the Test Base VHD.", + "pattern": "^[a-zA-Z0-9_.-]+$" + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/draftpackage.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/draftpackage.json new file mode 100644 index 000000000000..6b41a85adb95 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/draftpackage.json @@ -0,0 +1,1142 @@ +{ + "swagger": "2.0", + "info": { + "title": "Test Base", + "description": "Use these REST APIs for performing operations on Test Base Draft Packages, which are used to facilitate the creation and update of Test Base Package.", + "version": "2023-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/draftPackages": { + "get": { + "tags": [ + "Test Base Draft Package" + ], + "operationId": "DraftPackages_ListByTestBaseAccount", + "description": "Lists all the draft packages under a test base account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameQueryParameter" + }, + { + "$ref": "#/parameters/DraftPackageEditPackageParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/DraftPackageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DraftPackagesList": { + "$ref": "./examples/DraftPackagesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/draftPackages/{draftPackageName}": { + "put": { + "tags": [ + "Test Base Draft Package" + ], + "operationId": "DraftPackages_Create", + "description": "Creates or replaces a Test Base Draft Package.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DraftPackageResource" + }, + "description": "Parameters supplied to create a Test Base Draft Package." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/DraftPackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Draft Package was successfully updated.", + "schema": { + "$ref": "#/definitions/DraftPackageResource" + } + }, + "201": { + "description": "The Test Base Draft Package was successfully created.", + "schema": { + "$ref": "#/definitions/DraftPackageResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DraftPackageCreate": { + "$ref": "./examples/DraftPackageCreate.json" + } + } + }, + "patch": { + "tags": [ + "Test Base Draft Package" + ], + "operationId": "DraftPackages_Update", + "description": "Updates an existing Test Base Draft Package.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DraftPackageUpdateParameters" + }, + "description": "Parameters supplied to update a Test Base Draft Package." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/DraftPackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The existing Test Base Draft Package was successfully updated.", + "schema": { + "$ref": "#/definitions/DraftPackageResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DraftPackageUpdate": { + "$ref": "./examples/DraftPackageUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Test Base Draft Package" + ], + "operationId": "DraftPackages_Delete", + "description": "Deletes a Test Base Draft Package.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/DraftPackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Draft Package 'delete' operation was completed successfully." + }, + "204": { + "description": "The Test Base Draft Package 'delete' operation was completed successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DraftPackageDelete": { + "$ref": "./examples/DraftPackageDelete.json" + } + } + }, + "get": { + "tags": [ + "Test Base Draft Package" + ], + "operationId": "DraftPackages_Get", + "description": "Gets a Test Base Draft Package.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/DraftPackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Draft Package was successfully found.", + "schema": { + "$ref": "#/definitions/DraftPackageResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DraftPackageGet": { + "$ref": "./examples/DraftPackageGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/draftPackages/{draftPackageName}/getPath": { + "post": { + "tags": [ + "Test Base Draft Package" + ], + "operationId": "DraftPackages_GetPath", + "description": "Gets draft package path and temp working path with SAS.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/DraftPackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The paths with access token is returned.", + "schema": { + "$ref": "#/definitions/DraftPackageGetPathResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DraftPackageGetPath": { + "$ref": "./examples/DraftPackageGetPath.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/draftPackages/{draftPackageName}/copyFromPackage": { + "post": { + "tags": [ + "Test Base Draft Package" + ], + "operationId": "DraftPackages_CopyFromPackage", + "description": "Copy package file and metadata from a package to this draft package", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/DraftPackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CopyFromPackageOperationParameters" + }, + "description": "Parameters supplied to the Test Base Draft Package CopyFromPackage operation." + } + ], + "responses": { + "202": { + "description": "The operation was accepted. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "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-examples": { + "DraftPackageCopyFromPackage": { + "$ref": "./examples/DraftPackageCopyFromPackage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/draftPackages/{draftPackageName}/extractFile": { + "post": { + "tags": [ + "Test Base Draft Package" + ], + "operationId": "DraftPackages_ExtractFile", + "description": "Performs extracting file operation for a Test Base Draft Package", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/DraftPackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExtractFileOperationParameters" + }, + "description": "Parameters supplied to the Test Base Draft Package ExtractFile operation." + } + ], + "responses": { + "202": { + "description": "The 'ExtractFile' operation of Draft Package was accepted. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "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-examples": { + "DraftPackageExtractFile": { + "$ref": "./examples/DraftPackageExtractFile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/draftPackages/{draftPackageName}/generateFoldersAndScripts": { + "post": { + "tags": [ + "Test Base Draft Package" + ], + "operationId": "DraftPackages_GenerateFoldersAndScripts", + "description": "Generates folders and scripts", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./testbase.json#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/DraftPackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateOperationParameters" + }, + "description": "Parameters supplied to the Test Base Draft Package Generate operation." + } + ], + "responses": { + "202": { + "description": "The 'Generate' operation of Draft Package was accepted. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "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-examples": { + "DraftPackageGenerate": { + "$ref": "./examples/DraftPackageGenerateFoldersAndScripts.json" + } + } + } + } + }, + "definitions": { + "DraftPackageListResult": { + "description": "A list of Test Base Draft Packages.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DraftPackageResource" + }, + "description": "The list of Test Base Draft Packages." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "DraftPackageResource": { + "description": "The Test Base Draft Package resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DraftPackageProperties", + "x-ms-client-flatten": true, + "description": "Test Base Draft Package properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DraftPackageProperties": { + "description": "The properties of the Test Base Draft Package.", + "type": "object", + "properties": { + "applicationName": { + "type": "string", + "description": "Application name" + }, + "version": { + "type": "string", + "description": "Application version" + }, + "draftPackagePath": { + "type": "string", + "readOnly": true, + "description": "The relative path of the folder hosting package files." + }, + "workingPath": { + "type": "string", + "readOnly": true, + "description": "The relative path for a temporarily folder for package creation work." + }, + "appFileName": { + "type": "string", + "description": "The name of the app file." + }, + "sourceType": { + "$ref": "#/definitions/DraftPackageSourceType", + "description": "The source type.", + "default": "Native" + }, + "useSample": { + "type": "boolean", + "description": "Specifies whether a sample package should be used instead of the one uploaded by the user." + }, + "comments": { + "type": "string", + "description": "Comments added by user." + }, + "intuneMetadata": { + "type": "object", + "$ref": "#/definitions/DraftPackageIntuneAppMetadata", + "description": "Metadata used to generate draft package folder and scripts." + }, + "highlightedFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/HighlightedFile" + }, + "x-ms-identifiers": [], + "description": "The highlight files in the package." + }, + "packageTags": { + "description": "Tags of the package to be created.", + "$ref": "./testbase.json#/definitions/Tags" + }, + "editPackage": { + "type": "boolean", + "description": "Specifies whether this draft package is used to edit a package.", + "default": false + }, + "packageId": { + "type": "string", + "description": "Specifies the package id from which the draft package copied." + }, + "useAutofill": { + "type": "boolean", + "description": "Indicates whether user choose to enable script auto-fill." + }, + "executableLaunchCommand": { + "type": "string", + "description": "The executable launch command for script auto-fill. Will be used to run the application." + }, + "processName": { + "type": "string", + "description": "The process name for script auto-fill. Will be used to identify the application process." + }, + "tabState": { + "type": "object", + "$ref": "#/definitions/TabState", + "description": "Tab state." + }, + "testTypes": { + "type": "array", + "items": { + "$ref": "./testbase.json#/definitions/TestType" + }, + "description": "OOB, functional or flow driven. Mapped to the data in 'tests' property." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "./testbase.json#/definitions/ProvisioningState" + }, + "targetOSList": { + "type": "array", + "items": { + "$ref": "./testbase.json#/definitions/TargetOSInfo" + }, + "x-ms-identifiers": [], + "description": "Specifies the target OSs of specific OS Update types." + }, + "inplaceUpgradeOSPair": { + "$ref": "./testbase.json#/definitions/InplaceUpgradeOSInfo", + "description": "Specifies the baseline os and target os for inplace upgrade." + }, + "lastModifiedTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The UTC timestamp when the package was last modified." + }, + "flightingRing": { + "type": "string", + "description": "The flighting ring for feature update." + }, + "firstPartyApps": { + "description": "The list of first party applications to test along with user application.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "./testbase.json#/definitions/FirstPartyAppDefinition" + } + }, + "galleryApps": { + "description": "The list of gallery apps to test along with user application.", + "type": "array", + "x-ms-identifiers": [ + "skuId" + ], + "items": { + "$ref": "./testbase.json#/definitions/GalleryAppDefinition" + } + }, + "tests": { + "type": "array", + "items": { + "$ref": "./testbase.json#/definitions/Test" + }, + "x-ms-identifiers": [], + "description": "The detailed test information." + }, + "intuneEnrollmentMetadata": { + "description": "The metadata of Intune enrollment.", + "$ref": "./testbase.json#/definitions/IntuneEnrollmentMetadata" + } + } + }, + "DraftPackageUpdateParameters": { + "description": "Parameters supplied to update a Test Base Draft Package.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DraftPackageUpdateParameterProperties", + "x-ms-client-flatten": true, + "description": "Test Base Draft Package update parameters." + } + } + }, + "DraftPackageUpdateParameterProperties": { + "description": "The properties of draft package update parameters.", + "type": "object", + "properties": { + "applicationName": { + "type": "string", + "description": "Application name" + }, + "version": { + "type": "string", + "description": "Application version" + }, + "appFileName": { + "type": "string", + "description": "The name of the app file." + }, + "sourceType": { + "$ref": "#/definitions/DraftPackageSourceType", + "description": "The source type.", + "default": "Native" + }, + "useSample": { + "type": "boolean", + "description": "Specifies whether a sample package should be used instead of the one uploaded by the user." + }, + "comments": { + "type": "string", + "description": "Comments added by user." + }, + "intuneMetadata": { + "type": "object", + "$ref": "#/definitions/DraftPackageIntuneAppMetadata", + "description": "Metadata used to generate draft package folder and scripts." + }, + "highlightedFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/HighlightedFile" + }, + "x-ms-identifiers": [], + "description": "The highlight files in the package." + }, + "packageTags": { + "description": "Tags of the package to be created.", + "$ref": "./testbase.json#/definitions/Tags" + }, + "packageId": { + "type": "string", + "description": "Specifies the package id from which the draft package copied." + }, + "useAutofill": { + "type": "boolean", + "description": "Indicates whether user choose to enable script auto-fill." + }, + "executableLaunchCommand": { + "type": "string", + "description": "The executable launch command for script auto-fill. Will be used to run the application." + }, + "processName": { + "type": "string", + "description": "The process name for script auto-fill. Will be used to identify the application process." + }, + "tabState": { + "type": "object", + "$ref": "#/definitions/TabState", + "description": "Tab state." + }, + "testTypes": { + "type": "array", + "items": { + "$ref": "./testbase.json#/definitions/TestType" + }, + "description": "OOB, functional or flow driven. Mapped to the data in 'tests' property." + }, + "targetOSList": { + "type": "array", + "items": { + "$ref": "./testbase.json#/definitions/TargetOSInfo" + }, + "x-ms-identifiers": [], + "description": "Specifies the target OSs of specific OS Update types." + }, + "inplaceUpgradeOSPair": { + "$ref": "./testbase.json#/definitions/InplaceUpgradeOSInfo", + "description": "Specifies the baseline os and target os for in-place upgrade." + }, + "flightingRing": { + "type": "string", + "description": "The flighting ring for feature update." + }, + "firstPartyApps": { + "description": "Specifies the list of first party applications to test along with user application.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "./testbase.json#/definitions/FirstPartyAppDefinition" + } + }, + "galleryApps": { + "description": "The list of gallery apps to test along with user application.", + "type": "array", + "items": { + "$ref": "./testbase.json#/definitions/GalleryAppDefinition" + }, + "x-ms-identifiers": [ + "skuId" + ] + }, + "tests": { + "type": "array", + "items": { + "$ref": "./testbase.json#/definitions/Test" + }, + "x-ms-identifiers": [], + "description": "The detailed test information." + }, + "intuneEnrollmentMetadata": { + "description": "The metadata of Intune enrollment.", + "$ref": "./testbase.json#/definitions/IntuneEnrollmentMetadata" + } + } + }, + "DraftPackageSourceType": { + "type": "string", + "description": "The source type.", + "enum": [ + "Native", + "IntuneWin", + "TestBasePackage", + "GalleryApp", + "IntuneEnrollment" + ], + "x-ms-enum": { + "name": "draftPackageSourceType", + "modelAsString": true + } + }, + "DraftPackageIntuneAppMetadata": { + "description": "The metadata of Intune app(s) used for generation.", + "type": "object", + "properties": { + "intuneApp": { + "description": "The Metadata of the Intune App through intunewin file uploading.", + "$ref": "#/definitions/DraftPackageIntuneAppMetadataItem" + }, + "intuneAppDependencies": { + "type": "array", + "items": { + "$ref": "#/definitions/DraftPackageIntuneAppMetadataItem" + }, + "x-ms-identifiers": [], + "description": "The Metadata of dependencies of the Intune App through intunewin file uploading." + } + } + }, + "DraftPackageIntuneAppMetadataItem": { + "description": "The Metadata of a single Intune App.", + "type": "object", + "properties": { + "appName": { + "type": "string", + "description": "Intune app name." + }, + "version": { + "type": "string", + "description": "Intune app version." + }, + "appId": { + "type": "string", + "description": "Intune app id." + }, + "publisher": { + "type": "string", + "description": "Publisher of the app." + }, + "description": { + "type": "string", + "description": "Description of the app." + }, + "owner": { + "type": "string", + "description": "Owner of the app." + }, + "createDate": { + "type": "string", + "format": "date-time", + "description": "Creation date of the app." + }, + "dependentAppCount": { + "type": "integer", + "format": "int32", + "description": "Count of dependency apps." + }, + "installCommand": { + "type": "string", + "description": "Install command." + }, + "uninstallCommand": { + "type": "string", + "description": "Uninstall command." + }, + "lastProcessed": { + "type": "integer", + "format": "int64", + "description": "last processed time tickets." + }, + "dependencyIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Ids of dependency apps." + }, + "setupFile": { + "type": "string", + "description": "Setup file path." + }, + "minimumSupportedOS": { + "type": "string", + "description": "Minimum supported OS. The OS version must be greater than this version to run this app." + }, + "status": { + "enum": [ + "Ready", + "Uploading", + "UploadFailed", + "ExtractFailed", + "NoDependencyApp" + ], + "type": "string", + "x-ms-enum": { + "name": "intuneExtractStatus", + "modelAsString": true + }, + "description": "Extract status." + }, + "expectedExitCodes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Expected exit codes returned from Intune App." + } + } + }, + "HighlightedFile": { + "description": "The information of a highlighted file that user should pay attention to.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path of the highlighted file." + }, + "visited": { + "type": "boolean", + "description": "A flag to save whether this file is viewed by user.", + "default": false + }, + "sections": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The name of sections to highlight." + } + }, + "required": [ + "path" + ] + }, + "Tabs": { + "description": "Specifies the tabs when creating / cloning / editing a package.", + "type": "string", + "enum": [ + "Unspecified", + "BasicsTab", + "ConfigureTestTab", + "EditPackageTab", + "TestMatrixTab", + "TagsTab", + "ReviewAndCreateTab" + ], + "x-ms-enum": { + "name": "packageStudioTabs", + "modelAsString": true + } + }, + "TabState": { + "description": "Specifies current state of tabs.", + "type": "object", + "properties": { + "currentTab": { + "description": "Current tab.", + "$ref": "#/definitions/Tabs" + }, + "visitedTabs": { + "type": "array", + "items": { + "$ref": "#/definitions/Tabs" + }, + "description": "visited tabs." + } + } + }, + "DraftPackageGetPathResponse": { + "description": "The response of getting a download URL.", + "type": "object", + "properties": { + "baseUrl": { + "type": "string", + "readOnly": true, + "description": "The base URL of the storage account." + }, + "draftPackagePath": { + "type": "string", + "readOnly": true, + "description": "The relative path of the folder hosting package files." + }, + "workingPath": { + "type": "string", + "readOnly": true, + "description": "The relative path for a temporary folder for package creation work." + }, + "sasToken": { + "type": "string", + "readOnly": true, + "x-ms-secret": true, + "description": "A SAS token for the storage account to access workspace." + }, + "expirationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Expiry date of the SAS token." + } + } + }, + "ExtractFileOperationParameters": { + "description": "Parameters body to pass to extract file operation of Draft Package.", + "type": "object", + "properties": { + "fileType": { + "$ref": "#/definitions/ExtractFileType", + "description": "The type of file to extract.", + "default": "IntuneWinPackage" + }, + "sourceFile": { + "description": "Relative path of the file to be extracted, the path must under working path of this draft package.", + "type": "string" + }, + "intuneAppId": { + "description": "Intune application id.", + "type": "string" + } + }, + "required": [ + "sourceFile" + ] + }, + "ExtractFileType": { + "type": "string", + "description": "The type of file to extract.", + "enum": [ + "TestBasePackage", + "IntuneWinPackage" + ], + "x-ms-enum": { + "name": "extractFileType", + "modelAsString": true + } + }, + "GenerateOperationParameters": { + "description": "Parameters body to pass to generate operation of Draft Package.", + "type": "object", + "properties": { + "forceGenerate": { + "type": "boolean", + "description": "Force to generate package files even if no metadata changed.", + "default": false + } + } + }, + "CopyFromPackageOperationParameters": { + "description": "Parameters body to pass to copy-from-package operation of Draft Package.", + "type": "object", + "properties": { + "packageId": { + "description": "The id of the package to copy from.", + "type": "string" + } + }, + "required": [ + "packageId" + ] + } + }, + "parameters": { + "DraftPackageNameParameter": { + "name": "draftPackageName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of the Test Base Draft Package.", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9_]|([-. ][A-Za-z0-9]))+$" + }, + "PackageNameQueryParameter": { + "name": "packageName", + "in": "query", + "type": "string", + "x-ms-parameter-location": "method", + "description": "Parameter used to filter draft packages by linked Test Base Package." + }, + "DraftPackageEditPackageParameter": { + "name": "editPackage", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Parameter used to filter draft packages by editPackage property." + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestDelete.json new file mode 100644 index 000000000000..b76cccd09ec0 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "actionRequestName": "167184141414254", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestGet.json new file mode 100644 index 000000000000..b22d69e2c8b8 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "actionRequestName": "167184141414254", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "167184141414254", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/actionRequests/167184141414254", + "type": "Microsoft.TestBase/testBaseAccounts/actionRequests", + "properties": { + "requestType": "PreReleaseAccess", + "preReleaseAccessRequestSpec": { + "organizationName": "example-org-name", + "email": "example@example.com", + "engagements": [ + "MVI" + ], + "streetAddress": "example", + "city": "example", + "stateOrProvince": "example", + "zipCode": "example", + "countryAndRegion": "example", + "companyWebsite": "example.com" + }, + "creationDate": "2022-12-24T06:52:16.820Z", + "status": "InReview" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestList.json new file mode 100644 index 000000000000..8b7ce3fd627c --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "167184141414254", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/actionRequests/167184141414254", + "type": "Microsoft.TestBase/testBaseAccounts/actionRequests", + "properties": { + "requestType": "PreReleaseAccess", + "preReleaseAccessRequestSpec": { + "organizationName": "example-org-name", + "email": "example@example.com", + "engagements": [ + "MVI" + ], + "streetAddress": "example", + "city": "example", + "stateOrProvince": "example", + "zipCode": "example", + "countryAndRegion": "example", + "companyWebsite": "example.com" + }, + "creationDate": "2022-12-24T06:52:16.820Z", + "status": "InReview" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestPut.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestPut.json new file mode 100644 index 000000000000..ab5b37402ea2 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ActionRequestPut.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "actionRequestName": "167184141414254", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "167184141414254", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/actionRequests/167184141414254", + "type": "Microsoft.TestBase/testBaseAccounts/actionRequests", + "properties": { + "requestType": "PreReleaseAccess", + "preReleaseAccessRequestSpec": { + "organizationName": "example-org-name", + "email": "example@example.com", + "engagements": [ + "MVI" + ], + "streetAddress": "example", + "city": "example", + "stateOrProvince": "example", + "zipCode": "example", + "countryAndRegion": "example", + "companyWebsite": "example.com" + }, + "creationDate": "2022-12-24T06:52:16.820Z", + "status": "InReview" + } + } + }, + "201": { + "body": { + "name": "167184141414254", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/actionRequests/167184141414254", + "type": "Microsoft.TestBase/testBaseAccounts/actionRequests", + "properties": { + "requestType": "PreReleaseAccess", + "preReleaseAccessRequestSpec": { + "organizationName": "example-org-name", + "email": "example@example.com", + "engagements": [ + "MVI" + ], + "streetAddress": "example", + "city": "example", + "stateOrProvince": "example", + "zipCode": "example", + "countryAndRegion": "example", + "companyWebsite": "example.com" + }, + "creationDate": "2022-12-24T06:52:16.820Z", + "status": "InReview" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableInplaceUpgradeOSGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableInplaceUpgradeOSGet.json new file mode 100644 index 000000000000..420128e574a2 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableInplaceUpgradeOSGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "availableInplaceUpgradeOSResourceName": "Windows-10-1903", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "Windows-10-1903", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/availableInplaceUpgradeOSs/Windows-10-1903", + "type": "Microsoft.TestBase/testBaseAccounts/availableInplaceUpgradeOSs", + "properties": { + "sourceOsName": "Windows 10 1903", + "sourceOsReleases": [ + { + "releaseName": "2020.05 B", + "buildNumber": "18362", + "buildRevision": "830" + } + ], + "supportedTargetOsNameList": [ + "Windows 10 21H2", + "Windows 11 SV2" + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableInplaceUpgradeOSList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableInplaceUpgradeOSList.json new file mode 100644 index 000000000000..ee7a3fcee73d --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableInplaceUpgradeOSList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Windows-10-1903", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/availableInplaceUpgradeOSs/Windows-10-1903", + "type": "Microsoft.TestBase/testBaseAccounts/availableInplaceUpgradeOSs", + "properties": { + "sourceOsName": "Windows 10 1903", + "sourceOsReleases": [ + { + "releaseName": "2020.05 B", + "buildNumber": "18362", + "buildRevision": "830" + } + ], + "supportedTargetOsNameList": [ + "Windows 10 21H2", + "Windows 11 SV2" + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableOSGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableOSGet.json new file mode 100644 index 000000000000..30f656d43c7d --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableOSGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "availableOSResourceName": "Windows-10-2004", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "Windows-10-2004", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/availableOSs/Windows-10-2004", + "type": "Microsoft.TestBase/testBaseAccounts/availableOSs", + "properties": { + "osId": "Windows 10 2004", + "osName": "Windows 10 2004", + "osVersion": "Windows 10", + "insiderChannel": "Channel 1", + "osUpdateType": "Feature update", + "osPlatform": "Client" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableOSsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableOSsList.json new file mode 100644 index 000000000000..ea6897a81b28 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/AvailableOSsList.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "osUpdateType": "SecurityUpdate", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Windows-10-2004", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/availableOSs/Windows-10-2004", + "type": "Microsoft.TestBase/testBaseAccounts/availableOSs", + "properties": { + "osId": "Windows 10 2004", + "osName": "Windows 10 2004", + "osVersion": "Windows 10", + "insiderChannel": "Channel 1", + "osUpdateType": "Feature update", + "osPlatform": "Client" + } + }, + { + "name": "Windows-10-1909", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/availableOSs/Windows-10-1909", + "type": "Microsoft.TestBase/testBaseAccounts/availableOSs", + "properties": { + "osId": "Windows 10 1909", + "osName": "Windows 10 1909", + "osVersion": "Windows 10", + "osUpdateType": "Security update", + "osPlatform": "Client" + } + }, + { + "name": "Windows-10-1903", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/availableOSs/Windows-10-1903", + "type": "Microsoft.TestBase/testBaseAccounts/availableOSs", + "properties": { + "osId": "Windows 10 1903", + "osName": "Windows 10 1903", + "osVersion": "Windows 10", + "osUpdateType": "Security update", + "osPlatform": "Client" + } + }, + { + "name": "Windows-10-1809", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/availableOSs/Windows-10-1809", + "type": "Microsoft.TestBase/testBaseAccounts/availableOSs", + "properties": { + "osId": "Windows 10 1809", + "osName": "Windows 10 1809", + "osVersion": "Windows 10", + "insiderChannel": "Channel 3", + "osUpdateType": "Feature update", + "osPlatform": "Client" + } + }, + { + "name": "Windows-Server-2016", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/availableOSs/Windows-Server-2016", + "type": "Microsoft.TestBase/testBaseAccounts/availableOSs", + "properties": { + "osId": "Windows Server 2016", + "osName": "Windows Server 2016", + "osVersion": "Windows Server 2016", + "osUpdateType": "Security update", + "osPlatform": "Server" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/BillingHubGetFreeHourBalance.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/BillingHubGetFreeHourBalance.json new file mode 100644 index 000000000000..9fd8fc92db3c --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/BillingHubGetFreeHourBalance.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "totalRemainingFreeHours": 200, + "incrementEntries": [ + { + "freeHourType": "Temporary", + "freeHourStatus": "Enabled", + "createTimeStamp": "2022-03-12T12:51:38.709Z", + "expirationTimeStamp": "2022-04-12T12:51:38.709Z", + "incrementalFreeHours": 100, + "remainingFreeHours": 10 + }, + { + "freeHourType": "Temporary", + "freeHourStatus": "Enabled", + "createTimeStamp": "2022-03-13T12:51:38.709Z", + "expirationTimeStamp": "2022-04-13T12:51:38.709Z", + "incrementalFreeHours": 100, + "remainingFreeHours": 30 + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/BillingHubGetUsage.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/BillingHubGetUsage.json new file mode 100644 index 000000000000..f92c020812ba --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/BillingHubGetUsage.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview", + "startTimeStamp": "2022-01-12T12:05:25.632Z", + "endTimeStamp": "2022-03-12T12:05:25.632Z", + "continuousToken": "limit-50-offset-200" + }, + "responses": { + "200": { + "body": { + "totalUsedFreeHours": 0, + "totalUsedBillableHours": 0, + "totalCharges": 0, + "packageUsageEntries": [ + { + "applicationName": "test", + "applicationVersion": "1", + "azureResourceUri": "/SUBSCRIPTIONS/00000000-0000-0000-0000-000000000000/RESOURCEGROUPS/INTEGRATION-TEST/PROVIDERS/MICROSOFT.TESTBASE/TESTBASEACCOUNTS/TESTBASE-INTEGRATIONTEST/packages/test-1", + "totalUsedFreeHours": 20, + "totalUsedBillableHours": 5, + "totalCharges": 40, + "usageEntriesGroupedByUpdateType": [ + { + "updateType": "Security", + "totalUsedFreeHours": 10, + "totalUsedBillableHours": 5, + "totalCharges": 40, + "usageGroups": [ + { + "totalUsedFreeHours": 10, + "totalUsedBillableHours": 5, + "totalCharges": 40, + "releaseBuildRevision": 1237, + "releaseBuildNumber": 19044, + "releaseBuildDate": "2022-03-15T13:59:19.313Z", + "osBuild": "Windows Server 2022", + "release": "2022.02 B", + "testType": "Out of box test", + "productFamily": "Windows", + "executionUsageDetails": [ + { + "applicationName": "test", + "applicationVersion": "1", + "executionRequestId": "6298c3dc-7fed-4028-a5b8-34654322a1fe", + "sku": "TBD", + "meterId": "0f08918b-df38-4439-a328-b2b2254af793", + "startTimeStamp": "2022-03-14T08:11:58.761Z", + "endTimeStamp": "2022-03-14T08:11:58.761Z", + "osBuild": "Windows Server 2022", + "release": "2022.02 B", + "testType": "Out of box test", + "updateType": "Security", + "usedFreeHours": 5, + "usedBillableHours": 0, + "billedCharges": 0 + }, + { + "applicationName": "test", + "applicationVersion": "1", + "executionRequestId": "01187855-12bf-49f9-ae39-87acff5f6081", + "sku": "TBD", + "meterId": "bd84f3e2-a1f0-4a6f-b493-c7e42be94293", + "startTimeStamp": "2022-03-14T08:11:58.761Z", + "endTimeStamp": "2022-03-14T08:11:58.761Z", + "osBuild": "Windows Server 2022", + "release": "2022.02 B", + "testType": "Out of box test", + "updateType": "Security", + "usedFreeHours": 5, + "usedBillableHours": 5, + "billedCharges": 40 + } + ] + } + ] + }, + { + "updateType": "Feature", + "totalUsedFreeHours": 10, + "totalUsedBillableHours": 0, + "totalCharges": 0, + "usageGroups": [ + { + "totalUsedFreeHours": 10, + "totalUsedBillableHours": 0, + "totalCharges": 0, + "releaseBuildRevision": 1237, + "releaseBuildNumber": 19044, + "releaseBuildDate": "2022-03-15T13:59:19.313Z", + "osBuild": "Windows 10 21H2", + "release": "2021.09 B", + "testType": "Out of box test", + "productFamily": "Windows", + "executionUsageDetails": [ + { + "applicationName": "test", + "applicationVersion": "1", + "executionRequestId": "94d6ab44-dba2-4231-9aaf-7dd05aed1758", + "sku": "TBD", + "meterId": "1bbce8b9-b86e-43dc-8732-f69540b8f97a", + "startTimeStamp": "2022-03-14T08:11:58.761Z", + "endTimeStamp": "2022-03-14T08:11:58.761Z", + "osBuild": "Windows 10 21H2", + "release": "2021.09 B", + "testType": "Out of box test", + "updateType": "Feature", + "usedFreeHours": 10, + "usedBillableHours": 0, + "billedCharges": 0 + } + ] + } + ] + } + ] + } + ], + "nextRequest": { + "startTimeStamp": "2022-03-23T06:17:05.867Z", + "endTimeStamp": "2022-03-23T06:17:05.868Z", + "pageSize": 50, + "pageIndex": 15 + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPURegressionAnalysisResultGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPURegressionAnalysisResultGet.json new file mode 100644 index 000000000000..b083be926dee --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPURegressionAnalysisResultGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-Test-Id", + "analysisResultName": "cpuRegression", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "cpuRegression", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-Test-Id/analysisResults/cpuRegression", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults/analysisResults", + "properties": { + "grade": "Pass", + "analysisResultType": "CPURegression", + "cpuRegressionResults": [ + { + "fileName": "testApp.exe", + "grade": "Pass", + "details": "Some details of testApp", + "diff": 0.1, + "isRegressed": false + }, + { + "fileName": "dependencies.exe", + "grade": "Pass", + "details": "Some details of dependencies", + "diff": 0.15, + "isRegressed": false + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPURegressionAnalysisResultsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPURegressionAnalysisResultsList.json new file mode 100644 index 000000000000..f443cce8ea0c --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPURegressionAnalysisResultsList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-Test-Id", + "analysisResultType": "CPURegression", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cpuRegression", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-Test-Id/analysisResults/cpuRegression", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults/analysisResults", + "properties": { + "grade": "Pass", + "analysisResultType": "CPURegression", + "cpuRegressionResults": [ + { + "fileName": "testApp.exe", + "grade": "Pass", + "details": "Some details of testApp", + "diff": 0.1, + "isRegressed": false + }, + { + "fileName": "dependencies.exe", + "grade": "Pass", + "details": "Some details of dependencies", + "diff": 0.15, + "isRegressed": false + } + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPUUtilizationAnalysisResultGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPUUtilizationAnalysisResultGet.json new file mode 100644 index 000000000000..2b3e13ea99ac --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPUUtilizationAnalysisResultGet.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-Test-Id", + "analysisResultName": "cpuUtilization", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "cpuUtilization", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-Test-Id/analysisResults/cpuUtilization", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults/analysisResults", + "properties": { + "grade": "Pass", + "analysisResultType": "CPUUtilization", + "cpuUtilizationResults": [ + { + "process": "app.exe", + "upperBound": { + "percentile": 90.0, + "value": 60.0 + }, + "lowerBound": { + "percentile": 50.0, + "value": 20.0 + }, + "utilization": [ + { + "timestamp": "2020-12-28T17:30:00Z", + "value": 34.7 + }, + { + "timestamp": "2020-12-28T17:31:00Z", + "value": 35.9 + }, + { + "timestamp": "2020-12-28T17:32:00Z", + "value": 27.1 + }, + { + "timestamp": "2020-12-28T17:33:00Z", + "value": 49.8 + }, + { + "timestamp": "2020-12-28T17:34:00Z", + "value": 45.6 + } + ] + }, + { + "process": "anotherProcess.exe", + "upperBound": { + "percentile": 90.0, + "value": 60.0 + }, + "lowerBound": { + "percentile": 50.0, + "value": 20.0 + }, + "utilization": [ + { + "timestamp": "2020-12-28T17:30:00Z", + "value": 34.7 + }, + { + "timestamp": "2020-12-28T17:31:00Z", + "value": 35.9 + }, + { + "timestamp": "2020-12-28T17:32:00Z", + "value": 27.1 + }, + { + "timestamp": "2020-12-28T17:33:00Z", + "value": 49.8 + }, + { + "timestamp": "2020-12-28T17:34:00Z", + "value": 45.6 + } + ] + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPUUtilizationAnalysisResultsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPUUtilizationAnalysisResultsList.json new file mode 100644 index 000000000000..2bab21ac4463 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CPUUtilizationAnalysisResultsList.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-Test-Id", + "analysisResultType": "CPUUtilization", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cpuUtilization", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-Test-Id/analysisResults/cpuUtilization", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults/analysisResults", + "properties": { + "grade": "Pass", + "analysisResultType": "CPUUtilization", + "cpuUtilizationResults": [ + { + "process": "app.exe", + "upperBound": { + "percentile": 90.0, + "value": 60.0 + }, + "lowerBound": { + "percentile": 50.0, + "value": 20.0 + }, + "utilization": [ + { + "timestamp": "2020-12-28T17:30:00Z", + "value": 34.7 + }, + { + "timestamp": "2020-12-28T17:31:00Z", + "value": 35.9 + }, + { + "timestamp": "2020-12-28T17:32:00Z", + "value": 27.1 + }, + { + "timestamp": "2020-12-28T17:33:00Z", + "value": 49.8 + }, + { + "timestamp": "2020-12-28T17:34:00Z", + "value": 45.6 + } + ] + }, + { + "process": "anotherProcess.exe", + "upperBound": { + "percentile": 90.0, + "value": 60.0 + }, + "lowerBound": { + "percentile": 50.0, + "value": 20.0 + }, + "utilization": [ + { + "timestamp": "2020-12-28T17:30:00Z", + "value": 34.7 + }, + { + "timestamp": "2020-12-28T17:31:00Z", + "value": 35.9 + }, + { + "timestamp": "2020-12-28T17:32:00Z", + "value": 27.1 + }, + { + "timestamp": "2020-12-28T17:33:00Z", + "value": 49.8 + }, + { + "timestamp": "2020-12-28T17:34:00Z", + "value": 45.6 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ChatSessionChat.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ChatSessionChat.json new file mode 100644 index 000000000000..e87e4acbf288 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ChatSessionChat.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "chatSessionName": "e7520e9c-4017-4a92-aff2-d168670bb8ba", + "api-version": "2023-11-01-preview", + "parameters": { + "question": "What is Test Base for Microsoft 365?" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "question": "What is Test Base for Microsoft 365?", + "answer": "Test Base for Microsoft 365 is an Azure service that enables data-driven application testing while providing user access to intelligent testing from anywhere in the world. It is designed for Independent Software Vendors (ISVs), System Integrators (SIs), and IT Professionals who want to validate their applications and line-of-business (LOB) applications through integration with Microsoft Intune. Test Base helps ensure the integrity, compatibility, and usability of your applications as platform dependencies vary and new updates are applied by the Windows update service.", + "usage": 3, + "limit": 30 + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/providers/Microsoft.TestBase/locations/WESTUS/operationStatuses/45a0172d-3b48-41fd-b868-984bcd8ef40f*F096772A7EA7353A82ED9AC76507DC4D4FBD703CFEB6B8075FA354F683F8ACC8?api-version=2023-11-01-preview", + "location": "https://management.azure.com/providers/Microsoft.TestBase/locations/WESTUS/operationStatuses/45a0172d-3b48-41fd-b868-984bcd8ef40f*F096772A7EA7353A82ED9AC76507DC4D4FBD703CFEB6B8075FA354F683F8ACC8?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ChatSessionGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ChatSessionGet.json new file mode 100644 index 000000000000..efd81172571f --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ChatSessionGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "chatSessionName": "e7520e9c-4017-4a92-aff2-d168670bb8ba", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "e7520e9c-4017-4a92-aff2-d168670bb8ba", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/chatSessions/e7520e9c-4017-4a92-aff2-d168670bb8ba", + "type": "Microsoft.TestBase/testBaseAccounts/chatSessions", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ChatSessionList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ChatSessionList.json new file mode 100644 index 000000000000..3fce23ed6559 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ChatSessionList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "e7520e9c-4017-4a92-aff2-d168670bb8ba", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/chatSessions/e7520e9c-4017-4a92-aff2-d168670bb8ba", + "type": "Microsoft.TestBase/testBaseAccounts/chatSessions", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CheckImageNameAvailability.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CheckImageNameAvailability.json new file mode 100644 index 000000000000..738bf1f7d809 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CheckImageNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview", + "parameters": { + "definitionName": "contoso-image-def", + "versionName": "contoso-image-ver" + } + }, + "responses": { + "200": { + "body": { + "result": "Passed" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CheckPackageNameAvailability.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CheckPackageNameAvailability.json new file mode 100644 index 000000000000..126968f2917d --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CheckPackageNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview", + "parameters": { + "name": "testApp", + "applicationName": "testApp", + "version": "1.0.0", + "type": "Microsoft.TestBase/testBaseAccounts/packages" + } + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialCreate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialCreate.json new file mode 100644 index 000000000000..9d7805aa4428 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialCreate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "credentialName": "contoso-credential", + "api-version": "2023-11-01-preview", + "parameters": { + "properties": { + "credentialType": "IntuneAccount", + "displayName": "contoso-credential", + "userNameKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-username", + "passwordKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-password" + } + } + }, + "responses": { + "200": { + "body": { + "name": "contoso-credential", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/credentials/contoso-credential", + "type": "Microsoft.TestBase/testBaseAccounts/credentials", + "properties": { + "credentialType": "IntuneAccount", + "displayName": "contoso-credential", + "userNameKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-username", + "passwordKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-password" + } + } + }, + "201": { + "body": { + "name": "contoso-credential", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/credentials/contoso-credential", + "type": "Microsoft.TestBase/testBaseAccounts/credentials", + "properties": { + "credentialType": "IntuneAccount", + "displayName": "contoso-credential", + "userNameKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-username", + "passwordKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-password" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialDelete.json new file mode 100644 index 000000000000..7689bec09488 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "credentialName": "contoso-credential", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialGet.json new file mode 100644 index 000000000000..f32e78792d7a --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "credentialName": "contoso-credential", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "contoso-credential", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/credentials/contoso-credential", + "type": "Microsoft.TestBase/testBaseAccounts/credentials", + "properties": { + "credentialType": "IntuneAccount", + "displayName": "contoso-credential", + "userNameKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-username", + "passwordKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-password" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialUpdate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialUpdate.json new file mode 100644 index 000000000000..3837fa0518bd --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialUpdate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "credentialName": "contoso-credential", + "api-version": "2023-11-01-preview", + "parameters": { + "properties": { + "credentialType": "IntuneAccount", + "displayName": "contoso-credential", + "userNameKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-username", + "passwordKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-password" + } + } + }, + "responses": { + "200": { + "body": { + "name": "contoso-credential", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/credentials/contoso-credential", + "type": "Microsoft.TestBase/testBaseAccounts/credentials", + "properties": { + "credentialType": "IntuneAccount", + "displayName": "contoso-credential", + "userNameKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-username", + "passwordKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-password" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialsList.json new file mode 100644 index 000000000000..e0aec1bc68b7 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CredentialsList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contoso-credential", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/credentials/contoso-credential", + "type": "Microsoft.TestBase/testBaseAccounts/credentials", + "properties": { + "credentialType": "IntuneAccount", + "displayName": "contoso-credential", + "userNameKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-username", + "passwordKeyVaultSecretPath": "https://contoso-kv.vault.azure.net/secrets/contoso-kv-secret-password" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImageCreate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImageCreate.json new file mode 100644 index 000000000000..9a4cfd12d684 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImageCreate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "customImageName": "image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "api-version": "2023-11-01-preview", + "parameters": { + "properties": { + "definitionName": "contoso-image-def", + "versionName": "1.0.0", + "vhdId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/VHDs/vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "source": "VHD" + } + } + }, + "responses": { + "200": { + "body": { + "name": "image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customImages/image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "type": "Microsoft.TestBase/testBaseAccounts/customImages", + "properties": { + "provisioningState": "Succeeded", + "vhdId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/VHDs/vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "definitionName": "contoso-image-def", + "versionName": "1.0.0", + "source": "VHD", + "product": "Windows 10 22H2", + "release": "2022.10 B", + "status": "Validating", + "osDiskImageSizeInGB": 127 + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + }, + "body": { + "name": "image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customImages/image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "type": "Microsoft.TestBase/testBaseAccounts/customImages", + "properties": { + "provisioningState": "Creating", + "vhdId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/VHDs/vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "definitionName": "contoso-image-def", + "versionName": "1.0.0", + "source": "VHD", + "product": "Windows 10 22H2", + "release": "2022.10 B", + "osDiskImageSizeInGB": 127, + "creationTime": "2023-05-09T17:30:00Z" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImageDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImageDelete.json new file mode 100644 index 000000000000..fde035aeeba4 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImageDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "customImageName": "image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "api-version": "2023-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customImages/image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customImages/image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImageGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImageGet.json new file mode 100644 index 000000000000..f64f7ffaab3e --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImageGet.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "customImageName": "image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customImages/image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "type": "Microsoft.TestBase/testBaseAccounts/customImages", + "properties": { + "vhdId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/VHDs/vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "definitionName": "contoso-image-def", + "versionName": "1.0.0", + "source": "VHD", + "product": "Windows 10 22H2", + "release": "2022.10 B", + "status": "Ready", + "validationResults": { + "results": [ + { + "verificationName": "bootable", + "result": "Passed" + }, + { + "verificationName": "supportedProduct", + "result": "Failed", + "message": "Windows 10 1909 is unavailable in Test Base supported OS list." + }, + { + "verificationName": "autoLogonEnabled", + "result": "Passed" + }, + { + "verificationName": "vmAgentInstalled", + "result": "Passed" + } + ] + }, + "osDiskImageSizeInGB": 127, + "releaseVersionDate": "2023-12-24T06:52:16.820Z", + "creationTime": "2023-05-09T17:30:00Z" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImagesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImagesList.json new file mode 100644 index 000000000000..107178d56bde --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomImagesList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customImages/image-2cfb2edc-13bc-4d54-8d6e-38b2a233b003", + "type": "Microsoft.TestBase/testBaseAccounts/customImages", + "properties": { + "vhdId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/VHDs/vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "definitionName": "contoso-image-def", + "versionName": "1.0.0", + "source": "VHD", + "product": "Windows 10 22H2", + "release": "2022.10 B", + "status": "Ready", + "validationResults": { + "results": [ + { + "verificationName": "bootable", + "result": "Passed" + }, + { + "verificationName": "supportedProduct", + "result": "Failed", + "message": "Windows 10 1909 is unavailable in Test Base supported OS list." + }, + { + "verificationName": "autoLogonEnabled", + "result": "Passed" + }, + { + "verificationName": "vmAgentInstalled", + "result": "Passed" + } + ] + }, + "osDiskImageSizeInGB": 127, + "releaseVersionDate": "2023-12-24T06:52:16.820Z", + "creationTime": "2023-05-09T17:30:00Z" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventCreate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventCreate.json new file mode 100644 index 000000000000..207d80d2c248 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventCreate.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "customerEventName": "WeeklySummary", + "api-version": "2023-11-01-preview", + "parameters": { + "properties": { + "eventName": "WeeklySummary", + "receivers": [ + { + "receiverType": "UserObjects", + "receiverValue": { + "userObjectReceiverValue": { + "userObjectIds": [ + "245245245245325", + "365365365363565" + ] + } + } + }, + { + "receiverType": "DistributionGroup", + "receiverValue": { + "distributionGroupListReceiverValue": { + "distributionGroups": [ + "test@microsoft.com" + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "WeeklySummary", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/WeeklySummary", + "type": "Microsoft.TestBase/testBaseAccounts/customerEvents", + "properties": { + "eventName": "WeeklySummary", + "receivers": [ + { + "receiverType": "UserObjects", + "receiverValue": { + "userObjectReceiverValue": { + "userObjectIds": [ + "245245245245325", + "365365365363565" + ] + } + } + }, + { + "receiverType": "DistributionGroup", + "receiverValue": { + "distributionGroupListReceiverValue": { + "distributionGroups": [ + "test@microsoft.com" + ] + } + } + } + ] + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/WeeklySummary/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + }, + "body": { + "name": "WeeklySummary", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/WeeklySummary", + "type": "Microsoft.TestBase/testBaseAccounts/customerEvents", + "properties": { + "eventName": "WeeklySummary", + "receivers": [ + { + "receiverType": "UserObjects", + "receiverValue": { + "userObjectReceiverValue": { + "userObjectIds": [ + "245245245245325", + "365365365363565" + ] + } + } + }, + { + "receiverType": "DistributionGroup", + "receiverValue": { + "distributionGroupListReceiverValue": { + "distributionGroups": [ + "test@microsoft.com" + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventDelete.json new file mode 100644 index 000000000000..c76567ed3980 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "customerEventName": "WeeklySummary", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/WeeklySummary/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/WeeklySummary/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventGet.json new file mode 100644 index 000000000000..07f0a0b5abf3 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "customerEventName": "WeeklySummary", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/WeeklySummary", + "name": "WeeklySummary", + "type": "Microsoft.TestBase/testBaseAccounts/customerEvents", + "properties": { + "eventName": "WeeklySummary", + "receivers": [ + { + "receiverType": "UserObjects", + "receiverValue": { + "userObjectReceiverValue": { + "userObjectIds": [ + "245245245245325", + "365365365363565" + ] + } + } + }, + { + "receiverType": "SubscriptionRole", + "receiverValue": { + "subscriptionReceiverValue": { + "subscriptionId": "test-00000000-0000-0000-0000-000000000000", + "subscriptionName": "test-subscription", + "role": "Contributor" + } + } + }, + { + "receiverType": "DistributionGroup", + "receiverValue": { + "distributionGroupListReceiverValue": { + "distributionGroups": [ + "test@microsoft.com" + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventsList.json new file mode 100644 index 000000000000..0f9d432fd2cf --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/CustomerEventsList.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/ExecutionFailure", + "name": "ExecutionFailure", + "type": "Microsoft.TestBase/testBaseAccounts/customerEvents", + "properties": { + "eventName": "ExecutionFailure", + "receivers": [ + { + "receiverType": "SubscriptionRole", + "receiverValue": { + "subscriptionReceiverValue": { + "subscriptionId": "test-00000000-0000-0000-0000-000000000000", + "subscriptionName": "test-subscription", + "role": "Contributor" + } + } + }, + { + "receiverType": "DistributionGroup", + "receiverValue": { + "distributionGroupListReceiverValue": { + "distributionGroups": [ + "test@microsoft.com" + ] + } + } + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/customerEvents/WeeklySummary", + "name": "WeeklySummary", + "type": "Microsoft.TestBase/testBaseAccounts/customerEvents", + "properties": { + "eventName": "WeeklySummary", + "receivers": [ + { + "receiverType": "UserObjects", + "receiverValue": { + "userObjectReceiverValue": { + "userObjectIds": [ + "245245245245325", + "365365365363565" + ] + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageCopyFromPackage.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageCopyFromPackage.json new file mode 100644 index 000000000000..c2d13894bc9c --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageCopyFromPackage.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "draftPackageName": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "api-version": "2023-11-01-preview", + "parameters": { + "packageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/packages/contoso-package" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/MICROSOFT.TESTBASE/locations/WESTUS/operationStatuses/5b0a0eba-9487-411a-abdd-6aa12cc8d3fd*B91D9DCE4897B22607EFF0E21B7CDE4BEF5F59D1F7664BB8C638ADB23926DFDB?api-version=2022-04-01-preview", + "Location": "https://management.azure.com/providers/MICROSOFT.TESTBASE/locations/WESTUS/operationStatuses/5b0a0eba-9487-411a-abdd-6aa12cc8d3fd*B91D9DCE4897B22607EFF0E21B7CDE4BEF5F59D1F7664BB8C638ADB23926DFDB?api-version=2022-04-01-preview" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageCreate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageCreate.json new file mode 100644 index 000000000000..f4bcca1f043e --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageCreate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "draftPackageName": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "api-version": "2023-11-01-preview", + "parameters": { + "properties": { + "applicationName": "contoso-package", + "version": "1.0", + "appFileName": "TestBaseM365DigitalClock.msi", + "useSample": false, + "sourceType": "Native" + } + } + }, + "responses": { + "200": { + "body": { + "name": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/draftPackages/61d99543-14ff-47ae-bf03-8a8b8445502e", + "type": "Microsoft.TestBase/testBaseAccounts/draftpackages", + "properties": { + "applicationName": "contoso-package", + "version": "1.0", + "appFileName": "TestBaseM365DigitalClock.msi", + "useSample": false, + "sourceType": "Native" + } + } + }, + "201": { + "body": { + "name": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/draftPackages/61d99543-14ff-47ae-bf03-8a8b8445502e", + "type": "Microsoft.TestBase/testBaseAccounts/draftpackages", + "properties": { + "applicationName": "contoso-package", + "version": "1.0", + "appFileName": "TestBaseM365DigitalClock.msi", + "useSample": false, + "sourceType": "Native" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageDelete.json new file mode 100644 index 000000000000..f4fca4e6e788 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "draftPackageName": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageExtractFile.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageExtractFile.json new file mode 100644 index 000000000000..9e2ccb15ef76 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageExtractFile.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "draftPackageName": "34070901-fc0b-4459-b6de-4295b7c7bf19", + "api-version": "2023-11-01-preview", + "parameters": { + "fileType": "IntuneWinPackage", + "sourceFile": "bin/contoso.intunewin" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/MICROSOFT.TESTBASE/locations/WESTUS/operationStatuses/5b0a0eba-9487-411a-abdd-6aa12cc8d3fd*B91D9DCE4897B22607EFF0E21B7CDE4BEF5F59D1F7664BB8C638ADB23926DFDB?api-version=2022-04-01-preview", + "Location": "https://management.azure.com/providers/MICROSOFT.TESTBASE/locations/WESTUS/operationStatuses/5b0a0eba-9487-411a-abdd-6aa12cc8d3fd*B91D9DCE4897B22607EFF0E21B7CDE4BEF5F59D1F7664BB8C638ADB23926DFDB?api-version=2022-04-01-preview" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageGenerateFoldersAndScripts.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageGenerateFoldersAndScripts.json new file mode 100644 index 000000000000..0f34297a7698 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageGenerateFoldersAndScripts.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "draftPackageName": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "api-version": "2023-11-01-preview", + "parameters": { + "forceGenerate": false + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/MICROSOFT.TESTBASE/locations/WESTUS/operationStatuses/5b0a0eba-9487-411a-abdd-6aa12cc8d3fd*B91D9DCE4897B22607EFF0E21B7CDE4BEF5F59D1F7664BB8C638ADB23926DFDB?api-version=2022-04-01-preview", + "Location": "https://management.azure.com/providers/MICROSOFT.TESTBASE/locations/WESTUS/operationStatuses/5b0a0eba-9487-411a-abdd-6aa12cc8d3fd*B91D9DCE4897B22607EFF0E21B7CDE4BEF5F59D1F7664BB8C638ADB23926DFDB?api-version=2022-04-01-preview" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageGet.json new file mode 100644 index 000000000000..bad69b578101 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageGet.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "draftPackageName": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/draftPackages/61d99543-14ff-47ae-bf03-8a8b8445502e", + "type": "Microsoft.TestBase/testBaseAccounts/draftpackages", + "properties": { + "applicationName": "contoso-package", + "version": "1.0", + "draftPackagePath": "de0418a4-90a2-448f-b009-237803458cca/0c3e17c3-f6ce-4b22-b1be-6363e23a1857/draftPackagePath", + "workingPath": "de0418a4-90a2-448f-b009-237803458cca/0c3e17c3-f6ce-4b22-b1be-6363e23a1857/workingPath", + "appFileName": "TestBaseM365DigitalClock.msi", + "useSample": false, + "sourceType": "Native", + "testTypes": [ + "OutOfBoxTest", + "FunctionalTest" + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "validationRunStatus": "Unknown", + "validationResultId": null, + "isActive": true, + "commands": [ + { + "name": "install", + "action": "Install", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/install/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "launch", + "action": "Launch", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/launch/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "close", + "action": "Close", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/close/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/uninstall/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + } + ] + }, + { + "testType": "FunctionalTest", + "validationRunStatus": "Unknown", + "validationResultId": null, + "isActive": true, + "commands": [ + { + "name": "script1", + "action": "Custom", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/script1/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": true + } + ] + } + ], + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 11 21H2", + "Windows 10 21H2", + "Windows 10 21H1" + ], + "baselineOSs": null + }, + { + "osUpdateType": "Feature updates", + "targetOSs": [ + "Windows 10 21H2" + ], + "baselineOSs": null + } + ], + "flightingRing": "Insider Beta Channel", + "packageTags": {}, + "lastModifiedTime": "2022-05-25T10:37:21.9576117Z" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageGetPath.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageGetPath.json new file mode 100644 index 000000000000..26e6eedd1da2 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageGetPath.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "draftPackageName": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "baseUrl": "URL of storage account", + "draftPackagePath": "de0418a4-90a2-448f-b009-237803458cca/0c3e17c3-f6ce-4b22-b1be-6363e23a1857/draftPackagePath", + "workingPath": "de0418a4-90a2-448f-b009-237803458cca/0c3e17c3-f6ce-4b22-b1be-6363e23a1857/workingPath", + "expirationTime": "2022-08-01T09:20:48.2579928Z", + "sasToken": "access token" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageUpdate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageUpdate.json new file mode 100644 index 000000000000..fb898db697b2 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackageUpdate.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "draftPackageName": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "api-version": "2023-11-01-preview", + "parameters": { + "properties": { + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 11 21H2", + "Windows 10 21H2", + "Windows 10 21H1" + ], + "baselineOSs": null + }, + { + "osUpdateType": "Feature updates", + "targetOSs": [ + "Windows 10 21H2" + ], + "baselineOSs": null + } + ], + "flightingRing": "Insider Beta Channel" + } + } + }, + "responses": { + "200": { + "body": { + "name": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/draftPackages/61d99543-14ff-47ae-bf03-8a8b8445502e", + "type": "Microsoft.TestBase/testBaseAccounts/draftpackages", + "properties": { + "applicationName": "contoso-package", + "version": "1.0", + "draftPackagePath": "de0418a4-90a2-448f-b009-237803458cca/0c3e17c3-f6ce-4b22-b1be-6363e23a1857/draftPackagePath", + "workingPath": "de0418a4-90a2-448f-b009-237803458cca/0c3e17c3-f6ce-4b22-b1be-6363e23a1857/workingPath", + "appFileName": "TestBaseM365DigitalClock.msi", + "useSample": false, + "sourceType": "Native", + "testTypes": [ + "OutOfBoxTest", + "FunctionalTest" + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "validationRunStatus": "Unknown", + "validationResultId": null, + "isActive": true, + "commands": [ + { + "name": "install", + "action": "Install", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/install/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "launch", + "action": "Launch", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/launch/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "close", + "action": "Close", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/close/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/uninstall/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + } + ] + }, + { + "testType": "FunctionalTest", + "validationRunStatus": "Unknown", + "validationResultId": null, + "isActive": true, + "commands": [ + { + "name": "script1", + "action": "Custom", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/script1/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": true + } + ] + } + ], + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 11 21H2", + "Windows 10 21H2", + "Windows 10 21H1" + ], + "baselineOSs": null + }, + { + "osUpdateType": "Feature updates", + "targetOSs": [ + "Windows 10 21H2" + ], + "baselineOSs": null + } + ], + "flightingRing": "Insider Beta Channel", + "lastModifiedTime": "2022-05-25T10:37:21.9576117Z" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackagesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackagesList.json new file mode 100644 index 000000000000..cc92ae930c7a --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/DraftPackagesList.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "61d99543-14ff-47ae-bf03-8a8b8445502e", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/draftPackages/61d99543-14ff-47ae-bf03-8a8b8445502e", + "type": "Microsoft.TestBase/testBaseAccounts/draftpackages", + "properties": { + "applicationName": "contoso-package", + "version": "1.0", + "draftPackagePath": "de0418a4-90a2-448f-b009-237803458cca/0c3e17c3-f6ce-4b22-b1be-6363e23a1857/draftPackagePath", + "workingPath": "de0418a4-90a2-448f-b009-237803458cca/0c3e17c3-f6ce-4b22-b1be-6363e23a1857/workingPath", + "appFileName": "TestBaseM365DigitalClock.msi", + "useSample": false, + "sourceType": "Native", + "testTypes": [ + "OutOfBoxTest", + "FunctionalTest" + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "validationRunStatus": "Unknown", + "validationResultId": null, + "isActive": true, + "commands": [ + { + "name": "install", + "action": "Install", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/install/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "launch", + "action": "Launch", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/launch/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "close", + "action": "Close", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/close/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/uninstall/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + } + ] + }, + { + "testType": "FunctionalTest", + "validationRunStatus": "Unknown", + "validationResultId": null, + "isActive": true, + "commands": [ + { + "name": "script1", + "action": "Custom", + "contentType": "Path", + "content": "TestBaseM365DigitalClockApp/scripts/script1/job.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": true + } + ] + } + ], + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 11 21H2", + "Windows 10 21H2", + "Windows 10 21H1" + ], + "baselineOSs": null + }, + { + "osUpdateType": "Feature updates", + "targetOSs": [ + "Windows 10 21H2" + ], + "baselineOSs": null + } + ], + "flightingRing": "Insider Beta Channel", + "packageTags": {}, + "lastModifiedTime": "2022-05-25T10:37:21.9576117Z" + } + }, + { + "name": "34070901-fc0b-4459-b6de-4295b7c7bf19", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/draftPackages/34070901-fc0b-4459-b6de-4295b7c7bf19", + "type": "Microsoft.TestBase/testBaseAccounts/draftpackages", + "properties": { + "applicationName": "contoso-package2", + "version": "1.0", + "draftPackagePath": "de0418a4-90a2-448f-b009-237803458cca/0671155c-45fc-4758-916e-bd13337ffb68/draftPackagePath", + "workingPath": "de0418a4-90a2-448f-b009-237803458cca/0671155c-45fc-4758-916e-bd13337ffb68/workingPath", + "appFileName": "contoso.intunewin", + "useSample": true, + "sourceType": "IntuneWin", + "testTypes": [ + "OutOfBoxTest", + "FunctionalTest" + ], + "intuneMetadata": { + "intuneApp": { + "appName": "contoso", + "version": "1.0", + "appId": "4ae9a0c0-a7f5-4bd4-bf32-b61566eea954", + "createDate": "2022-03-16T07:12:19.8466431Z", + "dependentAppCount": 0, + "installCommand": "-exec install", + "uninstallCommand": "-exec uninstall", + "lastProcessed": 637890688335749600, + "dependencyIds": [], + "setupFile": "consoto.exe", + "status": "Ready" + }, + "intuneAppDependencies": [] + }, + "tests": [ + { + "testType": "FunctionalTest", + "validationRunStatus": "Unknown", + "validationResultId": null, + "isActive": true, + "commands": [ + { + "name": "script1", + "action": "Custom", + "contentType": "Path", + "content": "scripts/functional/script1.ps1", + "runElevated": false, + "restartAfter": true, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": true + }, + { + "name": "script2", + "action": "Custom", + "contentType": "Path", + "content": "scripts/functional/script2.ps1", + "runElevated": false, + "restartAfter": true, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + } + ] + }, + { + "testType": "OutOfBoxTest", + "validationRunStatus": "Unknown", + "validationResultId": null, + "isActive": true, + "commands": [ + { + "name": "install", + "action": "Install", + "contentType": "Path", + "content": "scripts/outofbox/install.ps1", + "runElevated": false, + "restartAfter": true, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "launch", + "action": "Launch", + "contentType": "Path", + "content": "scripts/outofbox/launch.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "close", + "action": "Close", + "contentType": "Path", + "content": "scripts/outofbox/close.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + }, + { + "name": "uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "scripts/outofbox/uninstall.ps1", + "runElevated": false, + "restartAfter": false, + "maxRunTime": 0, + "runAsInteractive": false, + "alwaysRun": false, + "applyUpdateBefore": false + } + ] + } + ], + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 10 21H1", + "Windows Server 2022" + ], + "baselineOSs": null + } + ], + "flightingRing": "", + "packageTags": {}, + "lastModifiedTime": "2022-05-27T10:11:55.4300989Z" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/EmailEventGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/EmailEventGet.json new file mode 100644 index 000000000000..93a7c7c8d58a --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/EmailEventGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "emailEventResourceName": "weekly-summary", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "weekly-summary", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/emailEvents/weekly-summary", + "type": "Microsoft.TestBase/testBaseAccounts/emailEvents", + "properties": { + "eventId": "weekly-summary", + "eventName": "weekly-summary", + "displayName": "Weekly Summary" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/EmailEventsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/EmailEventsList.json new file mode 100644 index 000000000000..26682af32edd --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/EmailEventsList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "weekly-summary", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/emailEvents/weekly-summary", + "type": "Microsoft.TestBase/testBaseAccounts/emailEvents", + "properties": { + "eventId": "weekly-summary", + "eventName": "weekly-summary", + "displayName": "Weekly Summary" + } + }, + { + "name": "daily-summary", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/emailEvents/daily-summary", + "type": "Microsoft.TestBase/testBaseAccounts/emailEvents", + "properties": { + "eventId": "daily-summary", + "eventName": "daily-summary", + "displayName": "Daily Summary" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessCreate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessCreate.json new file mode 100644 index 000000000000..0d518413bc90 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessCreate.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "favoriteProcessResourceName": "testAppProcess", + "api-version": "2023-11-01-preview", + "parameters": { + "properties": { + "actualProcessName": "testApp&.exe" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testAppProcess", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/favoriteProcesses/testAppProcess", + "type": "Microsoft.TestBase/testBaseAccounts/packages/favoriteProcesses", + "properties": { + "actualProcessName": "testApp&.exe" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessDelete.json new file mode 100644 index 000000000000..243ba948ccc4 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "favoriteProcessResourceName": "testAppProcess", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessGet.json new file mode 100644 index 000000000000..3e05edaa4af9 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "favoriteProcessResourceName": "testAppProcess", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "testAppProcess", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/favoriteProcesses/testAppProcess", + "type": "Microsoft.TestBase/testBaseAccounts/packages/favoriteProcesses", + "properties": { + "actualProcessName": "testApp&.exe" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessesList.json new file mode 100644 index 000000000000..3e9ddfe975bc --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FavoriteProcessesList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testAppProcess", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/favoriteProcesses/testAppProcess", + "type": "Microsoft.TestBase/testBaseAccounts/packages/favoriteProcesses", + "properties": { + "actualProcessName": "testApp&.exe" + } + }, + { + "name": "anotherProcess", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/favoriteProcesses/anotherProcess", + "type": "Microsoft.TestBase/testBaseAccounts/packages/favoriteProcesses", + "properties": { + "actualProcessName": "anotherProcess&&.exe" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FeatureUpdateSupportedOsesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FeatureUpdateSupportedOsesList.json new file mode 100644 index 000000000000..3308d63b7c63 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FeatureUpdateSupportedOsesList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Windows 11 22H2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/featureUpdateSupportedOses/Windows 11 22H2", + "type": "Microsoft.TestBase/testBaseAccounts/featureUpdateSupportedOses", + "properties": { + "osId": "Windows 11 22H2(Insider beta channel)", + "osName": "Windows 11 22H2", + "displayText": "Windows 11 22H2(Insider beta channel)", + "version": "WindowsSunValley", + "insiderChannel": "Insider beta channel", + "state": "Active", + "startTime": "2022-03-15T13:59:19.313Z", + "baselineProducts": [ + "Windows 11 22H1", + "Windows 10 21H2" + ] + } + } + ], + "nextLink": "mock-next-link" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FirstPartyAppGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FirstPartyAppGet.json new file mode 100644 index 000000000000..2e8e189db2bd --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FirstPartyAppGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "firstPartyAppResourceName": "firstPartyApp-fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "firstPartyApp-fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/firstPartyApps/firstPartyApp-fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "type": "Microsoft.TestBase/testBaseAccounts/firstPartyApps", + "properties": { + "mediaType": "Office", + "architecture": "x64", + "channel": "Current Channel", + "ring": "Insider", + "supportedProducts": [ + "Windows 10 20H2", + "Windows 11 21H1", + "Windows 11 21H2" + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FirstPartyAppsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FirstPartyAppsList.json new file mode 100644 index 000000000000..10fa6a02962f --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FirstPartyAppsList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "firstPartyApp-fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/firstPartyApps/firstPartyApp-fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "type": "Microsoft.TestBase/testBaseAccounts/firstPartyApps", + "properties": { + "mediaType": "Office", + "architecture": "x64", + "channel": "Current Office Channel", + "ring": "Insider", + "supportedProducts": [ + "Windows 10 20H2", + "Windows 11 21H1", + "Windows 11 21H2" + ] + } + }, + { + "name": "firstPartyApp-ef435271-7dcf-4014-b5dc-18ee14e338c0", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/firstPartyApps/firstPartyApp-ef435271-7dcf-4014-b5dc-18ee14e338c0", + "type": "Microsoft.TestBase/testBaseAccounts/firstPartyApps", + "properties": { + "mediaType": "Teams", + "architecture": "x64", + "channel": "Current Teams Channel", + "ring": "Insider", + "supportedProducts": [ + "Windows 10 20H2", + "Windows 11 21H1", + "Windows 11 21H2" + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FlightingRingGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FlightingRingGet.json new file mode 100644 index 000000000000..434532415dac --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FlightingRingGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "flightingRingResourceName": "Insider-Beta-Channel", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "Insider-Beta-Channel", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/flightingRings/Insider-Beta-Channel", + "type": "Microsoft.TestBase/testBaseAccounts/flightingRings", + "properties": { + "actualFlightingRingName": "Insider Beta Channel" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FlightingRingsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FlightingRingsList.json new file mode 100644 index 000000000000..9abdb59de686 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FlightingRingsList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Insider-Beta-Channel", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/flightingRings/Insider-Beta-Channel", + "type": "Microsoft.TestBase/testBaseAccounts/flightingRings", + "properties": { + "actualFlightingRingName": "Insider Beta Channel" + } + }, + { + "name": "Another-Channel", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/flightingRings/Another-Channel", + "type": "Microsoft.TestBase/testBaseAccounts/flightingRings", + "properties": { + "actualFlightingRingName": "Another Channel" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FreeHourBalanceGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FreeHourBalanceGet.json new file mode 100644 index 000000000000..12b691b2c585 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FreeHourBalanceGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "freeHourBalanceName": "TenantLevel", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "TenantLevel", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/freeHourBalances/TenantLevel", + "type": "Microsoft.TestBase/testBaseAccounts/freeHourBalances", + "properties": { + "totalRemainingFreeHours": 160.0, + "incrementEntries": [ + { + "freeHourType": "Permanent", + "freeHourStatus": "Enabled", + "incrementalFreeHours": 500, + "remainingFreeHours": 130.0, + "createTimeStamp": "2022-03-12T12:51:38.709Z", + "expirationTimeStamp": "2023-05-09T17:30:00Z" + }, + { + "freeHourType": "Temporary", + "freeHourStatus": "Enabled", + "incrementalFreeHours": 100, + "remainingFreeHours": 30.0, + "createTimeStamp": "2022-03-12T12:51:38.709Z", + "expirationTimeStamp": "2023-05-09T17:30:00Z" + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FreeHourBalancesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FreeHourBalancesList.json new file mode 100644 index 000000000000..d79cce7e7dbe --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/FreeHourBalancesList.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TenantLevel", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/freeHourBalances/TenantLevel", + "type": "Microsoft.TestBase/testBaseAccounts/freeHourBalances", + "properties": { + "totalRemainingFreeHours": 160.0, + "incrementEntries": [ + { + "freeHourType": "Permanent", + "freeHourStatus": "Enabled", + "incrementalFreeHours": 500, + "remainingFreeHours": 130.0, + "createTimeStamp": "2022-03-12T12:51:38.709Z", + "expirationTimeStamp": "2023-05-09T17:30:00Z" + }, + { + "freeHourType": "Temporary", + "freeHourStatus": "Enabled", + "incrementalFreeHours": 100, + "remainingFreeHours": 30.0, + "createTimeStamp": "2022-03-12T12:51:38.709Z", + "expirationTimeStamp": "2023-05-09T17:30:00Z" + } + ] + } + }, + { + "name": "SubscriptionLevel", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/freeHourBalances/SubscriptionLevel", + "type": "Microsoft.TestBase/testBaseAccounts/freeHourBalances", + "properties": { + "totalRemainingFreeHours": 60.0, + "incrementEntries": [ + { + "freeHourType": "Temporary", + "freeHourStatus": "Enabled", + "incrementalFreeHours": 100, + "remainingFreeHours": 30.0, + "createTimeStamp": "2022-03-12T12:51:38.709Z", + "expirationTimeStamp": "2023-05-09T17:30:00Z" + }, + { + "freeHourType": "Temporary", + "freeHourStatus": "Enabled", + "incrementalFreeHours": 100, + "remainingFreeHours": 30.0, + "createTimeStamp": "2022-03-12T12:51:38.709Z", + "expirationTimeStamp": "2023-05-09T17:30:00Z" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppGet.json new file mode 100644 index 000000000000..cabcaef35eaa --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "galleryAppName": "fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/galleryApps/fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "type": "Microsoft.TestBase/testBaseAccounts/galleryApps", + "properties": { + "applicationType": "Winget", + "applicationId": "Microsoft.Office", + "applicationName": "Microsoft 365 Apps for enterprise", + "popularity": 100 + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppSkuGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppSkuGet.json new file mode 100644 index 000000000000..be7d3497a832 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppSkuGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "galleryAppName": "fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "galleryAppSkuName": "ec898a20-df1e-4483-83e7-4bb37bb77385", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "ec898a20-df1e-4483-83e7-4bb37bb77385", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/galleryApps/fe51c56c-5dc0-499b-a807-a9d7746b34ae/galleryAppSkus/ec898a20-df1e-4483-83e7-4bb37bb77385", + "type": "Microsoft.TestBase/testBaseAccounts/galleryApps/galleryAppSkus", + "properties": { + "applicationType": "Winget", + "version": "16.0.15928.20196", + "license": "Commercial", + "licenseUrl": "https://docs.microsoft.com/legal/termsofuse" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppsList.json new file mode 100644 index 000000000000..0c7197f2030c --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppsList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "keyword": "office", + "top": 2, + "applicationType": "Winget", + "orderBy": "relevance", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/galleryApps/fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "type": "Microsoft.TestBase/testBaseAccounts/galleryApps", + "properties": { + "applicationType": "Winget", + "applicationId": "Microsoft.Office", + "applicationName": "Microsoft 365 Apps for enterprise", + "popularity": 100 + } + }, + { + "name": "ef435271-7dcf-4014-b5dc-18ee14e338c0", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/galleryApps/ef435271-7dcf-4014-b5dc-18ee14e338c0", + "type": "Microsoft.TestBase/testBaseAccounts/galleryApps", + "properties": { + "applicationType": "Winget", + "applicationId": "Microsoft.OneDrive", + "applicationName": "Microsoft OneDrive", + "popularity": 2 + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppsSkusList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppsSkusList.json new file mode 100644 index 000000000000..3e376a842810 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/GalleryAppsSkusList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "galleryAppName": "fe51c56c-5dc0-499b-a807-a9d7746b34ae", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Office-16.0.15928.20196", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/galleryApps/fe51c56c-5dc0-499b-a807-a9d7746b34ae/galleryAppSkus/Microsoft.Office-16.0.15928.20196", + "type": "Microsoft.TestBase/testBaseAccounts/galleryApps/galleryAppSkus", + "properties": { + "applicationType": "Winget", + "version": "16.0.15928.20196", + "license": "Commercial", + "licenseUrl": "https://docs.microsoft.com/legal/termsofuse" + } + }, + { + "name": "Microsoft.Office-16.0.15726.20188", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/galleryApps/fe51c56c-5dc0-499b-a807-a9d7746b34ae/galleryAppSkus/Microsoft.Office-16.0.15726.20188", + "type": "Microsoft.TestBase/testBaseAccounts/galleryApps/galleryAppSkus", + "properties": { + "applicationType": "Winget", + "version": "16.0.15726.20188", + "license": "Commercial", + "licenseUrl": "https://docs.microsoft.com/legal/termsofuse" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionCreate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionCreate.json new file mode 100644 index 000000000000..5bc4917cc082 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionCreate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "imageDefinitionName": "contoso-image-def", + "api-version": "2023-11-01-preview", + "parameters": { + "properties": { + "architecture": "x64", + "securityType": "Standard", + "osState": "Generalized" + } + } + }, + "responses": { + "200": { + "body": { + "name": "contoso-image-def", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/imageDefinitions/contoso-image-def", + "type": "Microsoft.TestBase/testBaseAccounts/imageDefinitions", + "properties": { + "architecture": "x64", + "securityType": "Standard", + "osState": "Generalized" + } + } + }, + "201": { + "body": { + "name": "contoso-image-def", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/imageDefinitions/contoso-image-def", + "type": "Microsoft.TestBase/testBaseAccounts/imageDefinitions", + "properties": { + "architecture": "x64", + "securityType": "Standard", + "osState": "Generalized" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionDelete.json new file mode 100644 index 000000000000..732a4e25fab9 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "imageDefinitionName": "contoso-image-def", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionGet.json new file mode 100644 index 000000000000..d59e8c7b3d79 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "imageDefinitionName": "contoso-image-def", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "contoso-image-def", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/imageDefinitions/contoso-image-def", + "type": "Microsoft.TestBase/testBaseAccounts/imageDefinitions", + "properties": { + "architecture": "x64", + "securityType": "Standard", + "osState": "Generalized" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionsList.json new file mode 100644 index 000000000000..fb6ea838520f --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ImageDefinitionsList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contoso-image-def", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/imageDefinitions/contoso-image-def", + "type": "Microsoft.TestBase/testBaseAccounts/imageDefinitions", + "properties": { + "architecture": "x64", + "securityType": "Standard", + "osState": "Generalized" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryRegressionAnalysisResultGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryRegressionAnalysisResultGet.json new file mode 100644 index 000000000000..baac86a85730 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryRegressionAnalysisResultGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-Test-Id", + "analysisResultName": "memoryRegression", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "memoryRegression", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-Test-Id/analysisResults/memoryRegression", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults/analysisResults", + "properties": { + "grade": "Pass", + "analysisResultType": "MemoryRegression", + "memoryRegressionResults": [ + { + "fileName": "testApp.exe", + "grade": "Pass", + "details": "Some details of testApp", + "diff": 0.1, + "isRegressed": false + }, + { + "fileName": "dependencies.exe", + "grade": "Pass", + "details": "Some details of dependencies", + "diff": 0.15, + "isRegressed": false + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryRegressionAnalysisResultsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryRegressionAnalysisResultsList.json new file mode 100644 index 000000000000..fe081f2b119e --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryRegressionAnalysisResultsList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-Test-Id", + "analysisResultType": "MemoryRegression", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "memoryRegression", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-Test-Id/analysisResults/memoryRegression", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults/analysisResults", + "properties": { + "grade": "Pass", + "analysisResultType": "MemoryRegression", + "memoryRegressionResults": [ + { + "fileName": "testApp.exe", + "grade": "Pass", + "details": "Some details of testApp", + "diff": 0.1, + "isRegressed": false + }, + { + "fileName": "dependencies.exe", + "grade": "Pass", + "details": "Some details of dependencies", + "diff": 0.15, + "isRegressed": false + } + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryUtilizationAnalysisResultGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryUtilizationAnalysisResultGet.json new file mode 100644 index 000000000000..0628ce73cb63 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryUtilizationAnalysisResultGet.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-Test-Id", + "analysisResultName": "memoryUtilization", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "memoryUtilization", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-Test-Id/analysisResults/memoryUtilization", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults/analysisResults", + "properties": { + "grade": "Pass", + "analysisResultType": "MemoryUtilization", + "memoryUtilizationResults": [ + { + "process": "app.exe", + "upperBound": { + "percentile": 90.0, + "value": 60.0 + }, + "lowerBound": { + "percentile": 50.0, + "value": 20.0 + }, + "utilization": [ + { + "timestamp": "2020-12-28T17:30:00Z", + "value": 34.7 + }, + { + "timestamp": "2020-12-28T17:31:00Z", + "value": 35.9 + }, + { + "timestamp": "2020-12-28T17:32:00Z", + "value": 27.1 + }, + { + "timestamp": "2020-12-28T17:33:00Z", + "value": 49.8 + }, + { + "timestamp": "2020-12-28T17:34:00Z", + "value": 45.6 + } + ] + }, + { + "process": "anotherProcess.exe", + "upperBound": { + "percentile": 90.0, + "value": 60.0 + }, + "lowerBound": { + "percentile": 50.0, + "value": 20.0 + }, + "utilization": [ + { + "timestamp": "2020-12-28T17:30:00Z", + "value": 34.7 + }, + { + "timestamp": "2020-12-28T17:31:00Z", + "value": 35.9 + }, + { + "timestamp": "2020-12-28T17:32:00Z", + "value": 27.1 + }, + { + "timestamp": "2020-12-28T17:33:00Z", + "value": 49.8 + }, + { + "timestamp": "2020-12-28T17:34:00Z", + "value": 45.6 + } + ] + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryUtilizationAnalysisResultsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryUtilizationAnalysisResultsList.json new file mode 100644 index 000000000000..2cf1dcfa5f2a --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/MemoryUtilizationAnalysisResultsList.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-Test-Id", + "analysisResultType": "MemoryUtilization", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cpuUtilization", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-Test-Id/analysisResults/memoryUtilization", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults/analysisResults", + "properties": { + "grade": "Pass", + "analysisResultType": "MemoryUtilization", + "memoryUtilizationResults": [ + { + "process": "app.exe", + "upperBound": { + "percentile": 90.0, + "value": 60.0 + }, + "lowerBound": { + "percentile": 50.0, + "value": 20.0 + }, + "utilization": [ + { + "timestamp": "2020-12-28T17:30:00Z", + "value": 34.7 + }, + { + "timestamp": "2020-12-28T17:31:00Z", + "value": 35.9 + }, + { + "timestamp": "2020-12-28T17:32:00Z", + "value": 27.1 + }, + { + "timestamp": "2020-12-28T17:33:00Z", + "value": 49.8 + }, + { + "timestamp": "2020-12-28T17:34:00Z", + "value": 45.6 + } + ] + }, + { + "process": "anotherProcess.exe", + "upperBound": { + "percentile": 90.0, + "value": 60.0 + }, + "lowerBound": { + "percentile": 50.0, + "value": 20.0 + }, + "utilization": [ + { + "timestamp": "2020-12-28T17:30:00Z", + "value": 34.7 + }, + { + "timestamp": "2020-12-28T17:31:00Z", + "value": 35.9 + }, + { + "timestamp": "2020-12-28T17:32:00Z", + "value": 27.1 + }, + { + "timestamp": "2020-12-28T17:33:00Z", + "value": 49.8 + }, + { + "timestamp": "2020-12-28T17:34:00Z", + "value": 45.6 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/OSUpdateGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/OSUpdateGet.json new file mode 100644 index 000000000000..c9a6c29af4a1 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/OSUpdateGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "osUpdateResourceName": "Windows-10-2004-2020-12-B-505", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "Windows-10-2004-2020-12-B-505", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/osUpdates/Windows-10-2004-2020-12-B-505", + "type": "Microsoft.TestBase/testBaseAccounts/packages/osUpdates", + "properties": { + "osName": "Windows 10 2004", + "release": "2020.12B", + "buildRevision": "505", + "type": "SecurityUpdate" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/OSUpdatesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/OSUpdatesList.json new file mode 100644 index 000000000000..a88e0f6bfd4f --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/OSUpdatesList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "osUpdateType": "SecurityUpdate", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Windows-10-2004-2020-12-B-505", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/osUpdates/Windows-10-2004-2020-12-B-505", + "type": "Microsoft.TestBase/testBaseAccounts/packages/osUpdates", + "properties": { + "osName": "Windows 10 2004", + "release": "2020.12B", + "buildRevision": "505", + "type": "SecurityUpdate" + } + }, + { + "name": "Windows-10-2004-2020-10-B-413", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/osUpdates/Windows-10-2004-2020-10-B-413", + "type": "Microsoft.TestBase/testBaseAccounts/packages/osUpdates", + "properties": { + "osName": "Windows 10 2004", + "release": "2020.10B", + "buildRevision": "413", + "type": "SecurityUpdate" + } + }, + { + "name": "Windows-10-2004-2020-08-B-226", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/osUpdates/Windows-10-2004-2020-08-B-226", + "type": "Microsoft.TestBase/testBaseAccounts/packages/osUpdates", + "properties": { + "osName": "Windows 10 2004", + "release": "2020.08B", + "buildRevision": "226", + "type": "SecurityUpdate" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/OperationsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..6c60204eb0d4 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/OperationsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestBase/operations?api-version=2023-11-01-preview&$skipToken=dummySkipToken", + "value": [ + { + "name": "Microsoft.TestBase/testBaseAccounts/read", + "display": { + "provider": "Microsoft Test Base", + "resource": "Test Base Account", + "operation": "View Test Base Account", + "description": "View the properties of a Test Base Account." + } + }, + { + "name": "Microsoft.TestBase/testBaseAccounts/write", + "display": { + "provider": "Microsoft Test Base", + "resource": "Test Base Account", + "operation": "Update Test Base Account", + "description": "Create a new Test Base Account or update the properties of an existing Test Base Account." + } + }, + { + "name": "Microsoft.TestBase/testBaseAccounts/delete", + "display": { + "provider": "Microsoft Test Base", + "resource": "Test Base Account", + "operation": "Delete Test Base Account", + "description": "Delete a Test Base Account." + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageCreate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageCreate.json new file mode 100644 index 000000000000..ec9091875748 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageCreate.json @@ -0,0 +1,326 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "api-version": "2023-11-01-preview", + "parameters": { + "location": "westus", + "tags": {}, + "properties": { + "applicationName": "contoso-package2", + "version": "1.0.0", + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 10 2004", + "Windows 10 1903" + ] + } + ], + "flightingRing": "Insider Beta Channel", + "blobPath": "storageAccountPath/package.zip", + "firstPartyApps": [ + { + "name": "Office", + "architecture": "x64", + "channel": "Current Channel", + "ring": "Insider", + "interopExecutionMode": "firstPartyAppWithTests" + } + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "isActive": true, + "commands": [ + { + "name": "Install", + "action": "Install", + "contentType": "Path", + "content": "app/scripts/install/job.ps1", + "runElevated": true, + "restartAfter": true, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": true + }, + { + "name": "Launch", + "action": "Launch", + "contentType": "Path", + "content": "app/scripts/launch/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": true, + "install1PAppBefore": false + }, + { + "name": "Close", + "action": "Close", + "contentType": "Path", + "content": "app/scripts/close/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": false, + "install1PAppBefore": false + }, + { + "name": "Uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "app/scripts/uninstall/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": false + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2", + "name": "contoso-package2", + "type": "Microsoft.TestBase/testBaseAccounts/packages", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "applicationName": "contoso-package2", + "version": "1.0.0", + "testTypes": [ + "OutOfBoxTest" + ], + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 10 2004", + "Windows 10 1903" + ] + } + ], + "packageStatus": "Ready", + "lastModifiedTime": "2020-12-28T17:30:00Z", + "flightingRing": "Insider Beta Channel", + "isEnabled": true, + "blobPath": "storageAccountPath/package.zip", + "firstPartyApps": [ + { + "name": "Office", + "architecture": "x64", + "channel": "Current Channel", + "ring": "Insider", + "interopExecutionMode": "firstPartyAppWithTests" + } + ], + "validationResults": [ + { + "validationName": "Syntax Validation", + "isValid": true + }, + { + "validationName": "Package Run Validation", + "isValid": true + } + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "validationRunStatus": "Passed", + "validationResultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0", + "isActive": true, + "commands": [ + { + "name": "Install", + "action": "Install", + "contentType": "Path", + "content": "app/scripts/install/job.ps1", + "runElevated": true, + "restartAfter": true, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": true + }, + { + "name": "Launch", + "action": "Launch", + "contentType": "Path", + "content": "app/scripts/launch/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": true, + "install1PAppBefore": false + }, + { + "name": "Close", + "action": "Close", + "contentType": "Path", + "content": "app/scripts/close/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": false, + "install1PAppBefore": false + }, + { + "name": "Uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "app/scripts/uninstall/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": false + } + ] + } + ] + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2", + "name": "contoso-package2", + "type": "Microsoft.TestBase/testBaseAccounts/packages", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "applicationName": "contoso-package2", + "version": "1.0.0", + "testTypes": [ + "OutOfBoxTest" + ], + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 10 2004", + "Windows 10 1903" + ] + } + ], + "packageStatus": "Ready", + "lastModifiedTime": "2020-12-28T17:30:00Z", + "flightingRing": "Insider Beta Channel", + "isEnabled": true, + "blobPath": "storageAccountPath/package.zip", + "firstPartyApps": [ + { + "name": "Office", + "architecture": "x64", + "channel": "Current Channel", + "ring": "Insider", + "interopExecutionMode": "firstPartyAppWithTests" + } + ], + "validationResults": [ + { + "validationName": "Syntax Validation", + "isValid": true + }, + { + "validationName": "Package Run Validation", + "isValid": true + } + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "validationRunStatus": "Passed", + "validationResultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0", + "isActive": true, + "commands": [ + { + "name": "Install", + "action": "Install", + "contentType": "Path", + "content": "app/scripts/install/job.ps1", + "runElevated": true, + "restartAfter": true, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": true + }, + { + "name": "Launch", + "action": "Launch", + "contentType": "Path", + "content": "app/scripts/launch/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": true, + "install1PAppBefore": false + }, + { + "name": "Close", + "action": "Close", + "contentType": "Path", + "content": "app/scripts/close/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": false, + "install1PAppBefore": false + }, + { + "name": "Uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "app/scripts/uninstall/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": false + } + ] + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageDelete.json new file mode 100644 index 000000000000..370aeae463f3 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageGet.json new file mode 100644 index 000000000000..ecd7afac2232 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageGet.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2", + "name": "contoso-package2", + "type": "Microsoft.TestBase/testBaseAccounts/packages", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "applicationName": "contoso-package2", + "version": "1.0.0", + "testTypes": [ + "OutOfBoxTest" + ], + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 10 2004", + "Windows 10 1903" + ] + } + ], + "packageStatus": "Ready", + "lastModifiedTime": "2020-12-28T17:30:00Z", + "flightingRing": "Insider Beta Channel", + "isEnabled": true, + "blobPath": "storageAccountPath/package.zip", + "firstPartyApps": [ + { + "name": "Office", + "architecture": "x64", + "channel": "Current Channel", + "ring": "Insider", + "interopExecutionMode": "firstPartyAppWithTests" + } + ], + "galleryApps": [ + { + "skuId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/galleryApps/fe51c56c-5dc0-499b-a807-a9d7746b34ae/galleryAppSkus/docker-4.14.1", + "isConsented": true + } + ], + "validationResults": [ + { + "validationName": "Syntax Validation", + "isValid": true + }, + { + "validationName": "Package Run Validation", + "isValid": true + } + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "validationRunStatus": "Passed", + "validationResultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0", + "isActive": true, + "commands": [ + { + "name": "Install", + "action": "Install", + "contentType": "Path", + "content": "app/scripts/install/job.ps1", + "runElevated": true, + "restartAfter": true, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": true + }, + { + "name": "Launch", + "action": "Launch", + "contentType": "Path", + "content": "app/scripts/launch/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": true, + "install1PAppBefore": false + }, + { + "name": "Close", + "action": "Close", + "contentType": "Path", + "content": "app/scripts/close/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": false, + "install1PAppBefore": false + }, + { + "name": "Uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "app/scripts/uninstall/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": false + } + ] + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageGetDownloadURL.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageGetDownloadURL.json new file mode 100644 index 000000000000..c591a2d778e2 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageGetDownloadURL.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "downloadUrl": "some URL", + "expirationTime": "2021-01-10T06:00:00Z" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageHardDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageHardDelete.json new file mode 100644 index 000000000000..370aeae463f3 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageHardDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageRunTest.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageRunTest.json new file mode 100644 index 000000000000..1250334ca8a6 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageRunTest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "api-version": "2023-11-01-preview", + "parameters": { + "testType": "OutOfBoxTest", + "osUpdateType": "SecurityUpdate", + "osName": "Windows 10 21H1", + "releaseName": "2021.05 B" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageUpdate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageUpdate.json new file mode 100644 index 000000000000..8fb3fead1640 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackageUpdate.json @@ -0,0 +1,221 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "api-version": "2023-11-01-preview", + "parameters": { + "tags": {}, + "properties": { + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 10 2004", + "Windows 10 1903" + ] + } + ], + "flightingRing": "Insider Beta Channel", + "isEnabled": false, + "blobPath": "storageAccountPath/package.zip", + "firstPartyApps": [ + { + "name": "Office", + "architecture": "x64", + "channel": "Current Channel", + "ring": "Insider", + "interopExecutionMode": "firstPartyAppWithTests" + } + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "isActive": true, + "commands": [ + { + "name": "Install", + "action": "Install", + "contentType": "Path", + "content": "app/scripts/install/job.ps1", + "runElevated": true, + "restartAfter": true, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": true + }, + { + "name": "Launch", + "action": "Launch", + "contentType": "Path", + "content": "app/scripts/launch/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": true, + "install1PAppBefore": false + }, + { + "name": "Close", + "action": "Close", + "contentType": "Path", + "content": "app/scripts/close/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": false, + "install1PAppBefore": false + }, + { + "name": "Uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "app/scripts/uninstall/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": false + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2", + "name": "contoso-package2", + "type": "Microsoft.TestBase/testBaseAccounts/packages", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "applicationName": "contoso-package2", + "version": "1.0.0", + "testTypes": [ + "OutOfBoxTest" + ], + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 10 2004", + "Windows 10 1903" + ] + } + ], + "packageStatus": "Ready", + "lastModifiedTime": "2020-12-28T17:30:00Z", + "flightingRing": "Insider Beta Channel", + "isEnabled": false, + "blobPath": "storageAccountPath/package.zip", + "validationResults": [ + { + "validationName": "Syntax Validation", + "isValid": true + }, + { + "validationName": "Package Run Validation", + "isValid": true + } + ], + "firstPartyApps": [ + { + "name": "Office", + "architecture": "x64", + "channel": "Current Channel", + "ring": "Insider", + "interopExecutionMode": "firstPartyAppWithTests" + } + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "validationRunStatus": "Passed", + "validationResultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0", + "isActive": true, + "commands": [ + { + "name": "Install", + "action": "Install", + "contentType": "Path", + "content": "app/scripts/install/job.ps1", + "runElevated": true, + "restartAfter": true, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": true + }, + { + "name": "Launch", + "action": "Launch", + "contentType": "Path", + "content": "app/scripts/launch/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": true, + "install1PAppBefore": false + }, + { + "name": "Close", + "action": "Close", + "contentType": "Path", + "content": "app/scripts/close/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": false, + "install1PAppBefore": false + }, + { + "name": "Uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "app/scripts/uninstall/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": false + } + ] + } + ] + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackagesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackagesList.json new file mode 100644 index 000000000000..4ccd17cc9e4f --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/PackagesList.json @@ -0,0 +1,282 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package1", + "name": "contoso-package1", + "type": "Microsoft.TestBase/testBaseAccounts/packages", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "applicationName": "contoso-package1", + "version": "1.0.0", + "testTypes": [ + "OutOfBoxTest", + "FunctionalTest" + ], + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 10 2004", + "Windows 10 1903" + ] + }, + { + "osUpdateType": "Feature updates", + "targetOSs": [ + "Windows 10 2004", + "Windows 10 1903", + "Windows 10 1809" + ], + "baselineOSs": [ + "Windows 10 1809" + ] + } + ], + "packageStatus": "Ready", + "lastModifiedTime": "2020-12-28T17:30:00Z", + "flightingRing": "Insider Beta Channel", + "isEnabled": true, + "blobPath": "storageAccountPath/package.zip", + "validationResults": [ + { + "validationName": "Syntax Validation", + "isValid": true + }, + { + "validationName": "Package Run Validation", + "isValid": true + } + ], + "firstPartyApps": [ + { + "name": "Office", + "architecture": "x86", + "channel": "Current Channel", + "ring": "Insider", + "interopExecutionMode": "firstPartyAppWithTests" + } + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "validationRunStatus": "Passed", + "validationResultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package1/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0", + "isActive": true, + "commands": [ + { + "name": "Install", + "action": "Install", + "contentType": "Path", + "content": "app/scripts/install/job.ps1", + "runElevated": true, + "restartAfter": true, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": true + }, + { + "name": "Launch", + "action": "Launch", + "contentType": "Path", + "content": "app/scripts/launch/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": true, + "install1PAppBefore": false + }, + { + "name": "Close", + "action": "Close", + "contentType": "Path", + "content": "app/scripts/close/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": false, + "install1PAppBefore": false + }, + { + "name": "Uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "app/scripts/uninstall/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": false + } + ] + }, + { + "testType": "FunctionalTest", + "validationRunStatus": "Passed", + "validationResultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package1/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0", + "isActive": true, + "commands": [ + { + "name": "Custom1", + "action": "Custom", + "contentType": "Path", + "content": "app/scripts/custom/custom1.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": false + }, + { + "name": "Custom2", + "action": "Custom", + "contentType": "Path", + "content": "app/scripts/custom/custom2.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": true, + "install1PAppBefore": true + } + ] + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2", + "name": "contoso-package2", + "type": "Microsoft.TestBase/testBaseAccounts/packages", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "applicationName": "contoso-package2", + "version": "1.0.0", + "testTypes": [ + "OutOfBoxTest" + ], + "targetOSList": [ + { + "osUpdateType": "Security updates", + "targetOSs": [ + "Windows 10 2004", + "Windows 10 1903" + ] + } + ], + "packageStatus": "Ready", + "lastModifiedTime": "2020-12-28T17:30:00Z", + "flightingRing": "Insider Beta Channel", + "isEnabled": true, + "blobPath": "storageAccountPath/package.zip", + "validationResults": [ + { + "validationName": "Syntax Validation", + "isValid": true + }, + { + "validationName": "Package Run Validation", + "isValid": true + } + ], + "firstPartyApps": [ + { + "name": "Office", + "architecture": "x64", + "channel": "Current Channel", + "ring": "Insider", + "interopExecutionMode": "firstPartyAppWithTests" + } + ], + "tests": [ + { + "testType": "OutOfBoxTest", + "validationRunStatus": "Passed", + "validationResultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0", + "isActive": true, + "commands": [ + { + "name": "Install", + "action": "Install", + "contentType": "Path", + "content": "app/scripts/install/job.ps1", + "runElevated": true, + "restartAfter": true, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": true + }, + { + "name": "Launch", + "action": "Launch", + "contentType": "Path", + "content": "app/scripts/launch/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": true, + "install1PAppBefore": false + }, + { + "name": "Close", + "action": "Close", + "contentType": "Path", + "content": "app/scripts/close/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": false, + "applyUpdateBefore": false, + "install1PAppBefore": false + }, + { + "name": "Uninstall", + "action": "Uninstall", + "contentType": "Path", + "content": "app/scripts/uninstall/job.ps1", + "runElevated": true, + "restartAfter": false, + "maxRunTime": 1800, + "runAsInteractive": true, + "alwaysRun": true, + "applyUpdateBefore": false, + "install1PAppBefore": false + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ScriptExecutionAnalysisResultGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ScriptExecutionAnalysisResultGet.json new file mode 100644 index 000000000000..47baeeaddead --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ScriptExecutionAnalysisResultGet.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-Test-Id", + "analysisResultName": "scriptExecution", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "scriptExecution", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-Test-Id/analysisResults/scriptExecution", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults/analysisResults", + "properties": { + "grade": "Pass", + "analysisResultType": "ScriptExecution", + "scriptExecutionResults": [ + { + "scriptName": "install", + "startTime": "2021-10-19T09:52:02.451Z", + "endTime": "2021-10-19T09:52:05.244Z", + "exitCode": 0, + "timedOut": false, + "stdoutLogFileName": "install-stdout-1234.log", + "stderrLogFileName": "install-stderr-1234.log" + }, + { + "scriptName": "launch", + "startTime": "2021-10-19T10:08:21.187Z", + "endTime": "2021-10-19T10:08:58.378Z", + "exitCode": 0, + "timedOut": false, + "stdoutLogFileName": "launch-stdout-1234.log", + "stderrLogFileName": "launch-stderr-1234.log" + }, + { + "scriptName": "close", + "startTime": "2021-10-19T10:09:15.981Z", + "endTime": "2021-10-19T10:09:19.59Z", + "exitCode": 0, + "timedOut": false, + "stdoutLogFileName": "close-stdout-1234.log", + "stderrLogFileName": "close-stderr-1234.log" + }, + { + "scriptName": "uninstall", + "startTime": "2021-10-19T10:10:49Z", + "endTime": "2021-10-19T10:10:55.082Z", + "exitCode": 0, + "timedOut": false, + "stdoutLogFileName": "uninstall-stdout-1234.log", + "stderrLogFileName": "uninstall-stderr-1234.log" + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ScriptExecutionAnalysisResultsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ScriptExecutionAnalysisResultsList.json new file mode 100644 index 000000000000..87c1b47cdf45 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/ScriptExecutionAnalysisResultsList.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-Test-Id", + "analysisResultType": "ScriptExecution", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scriptExecution", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-Test-Id/analysisResults/scriptExecution", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults/analysisResults", + "properties": { + "grade": "Pass", + "analysisResultType": "ScriptExecution", + "scriptExecutionResults": [ + { + "scriptName": "install", + "startTime": "2021-10-19T09:52:02.451Z", + "endTime": "2021-10-19T09:52:05.244Z", + "exitCode": 0, + "timedOut": false, + "stdoutLogFileName": "install-stdout-1234.log", + "stderrLogFileName": "install-stderr-1234.log" + }, + { + "scriptName": "launch", + "startTime": "2021-10-19T10:08:21.187Z", + "endTime": "2021-10-19T10:08:58.378Z", + "exitCode": 0, + "timedOut": false, + "stdoutLogFileName": "launch-stdout-1234.log", + "stderrLogFileName": "launch-stderr-1234.log" + }, + { + "scriptName": "close", + "startTime": "2021-10-19T10:09:15.981Z", + "endTime": "2021-10-19T10:09:19.59Z", + "exitCode": 0, + "timedOut": false, + "stdoutLogFileName": "close-stdout-1234.log", + "stderrLogFileName": "close-stderr-1234.log" + }, + { + "scriptName": "uninstall", + "startTime": "2021-10-19T10:10:49Z", + "endTime": "2021-10-19T10:10:55.082Z", + "exitCode": 0, + "timedOut": false, + "stdoutLogFileName": "uninstall-stdout-1234.log", + "stderrLogFileName": "uninstall-stderr-1234.log" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountCreate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountCreate.json new file mode 100644 index 000000000000..fb3b61d09575 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountCreate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview", + "parameters": { + "location": "westus", + "properties": { + "sku": { + "name": "S0", + "tier": "Standard" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1", + "name": "contoso-testBaseAccount1", + "type": "Microsoft.TestBase/testBaseAccounts", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "S0", + "tier": "Standard", + "capabilities": [ + { + "name": "SLA", + "value": "99.9%" + }, + { + "name": "maximumPackageCount", + "value": "5" + }, + { + "name": "packageMaximumRunSeconds", + "value": "3600" + } + ] + }, + "accessLevel": "StandardAccess" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1", + "name": "contoso-testBaseAccount1", + "type": "Microsoft.TestBase/testBaseAccounts", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "sku": { + "name": "S0", + "tier": "Standard", + "capabilities": [ + { + "name": "SLA", + "value": "99.9%" + }, + { + "name": "maximumPackageCount", + "value": "5" + }, + { + "name": "packageMaximumRunSeconds", + "value": "3600" + } + ] + }, + "accessLevel": "StandardAccess" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountDelete.json new file mode 100644 index 000000000000..5f6a0ff798ca --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountGet.json new file mode 100644 index 000000000000..fe0773dd91ec --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1", + "name": "contoso-testBaseAccount1", + "type": "Microsoft.TestBase/testBaseAccounts", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "S0", + "tier": "Standard", + "capabilities": [ + { + "name": "SLA", + "value": "99.9%" + }, + { + "name": "maximumPackageCount", + "value": "5" + }, + { + "name": "packageMaximumRunSeconds", + "value": "3600" + } + ] + }, + "accessLevel": "EarlyAccess" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountGetFileUploadUrl.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountGetFileUploadUrl.json new file mode 100644 index 000000000000..873c342bea8c --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountGetFileUploadUrl.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview", + "parameters": { + "blobName": "package.zip" + } + }, + "responses": { + "200": { + "body": { + "uploadUrl": "https://uslwestusdevsa.blob.core.windows.net/usltest/temp/20c0d7e0-1bb6-477f-bc04-57c734453000/token", + "blobPath": "https://uslwestusdevsa.blob.core.windows.net/usltest/temp/20c0d7e0-1bb6-477f-bc04-57c734453000/package.zip" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountOffboard.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountOffboard.json new file mode 100644 index 000000000000..5f6a0ff798ca --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountOffboard.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountSKUsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountSKUsList.json new file mode 100644 index 000000000000..471704b442ee --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountSKUsList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestBase/skus?api-version=2023-11-01-preview&$skipToken=dummySkipToken", + "value": [ + { + "resourceType": "testBaseAccounts", + "name": "S0", + "tier": "Standard", + "locations": [ + "global" + ], + "capabilities": [] + }, + { + "resourceType": "testBaseAccounts", + "name": "S0", + "tier": "Standard", + "locations": [ + "global" + ], + "capabilities": [] + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountUpdate.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountUpdate.json new file mode 100644 index 000000000000..5e12c4ae18bd --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountUpdate.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview", + "parameters": { + "properties": { + "sku": { + "name": "S0", + "tier": "Standard" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1", + "name": "contoso-testBaseAccount1", + "type": "Microsoft.TestBase/testBaseAccounts", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "S0", + "tier": "Standard", + "capabilities": [ + { + "name": "SLA", + "value": "99.9%" + }, + { + "name": "maximumPackageCount", + "value": "5" + }, + { + "name": "packageMaximumRunSeconds", + "value": "3600" + } + ] + }, + "accessLevel": "EarlyAccess" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2023-11-01-preview" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountUsagesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountUsagesList.json new file mode 100644 index 000000000000..4a5e50069072 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountUsagesList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.TestBase/contoso-testBaseAccount1/usages?api-version=2023-11-01-preview&$skipToken=dummySkipToken", + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/usages/contoso-package1-usage", + "name": { + "value": "contoso-package1-usage", + "localizedValue": "contoso-package1-usage" + }, + "unit": "Seconds", + "limit": -1, + "currentValue": 7531 + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/usages/contoso-package2-usage", + "name": { + "value": "contoso-package2-usage", + "localizedValue": "contoso-package2-usage" + }, + "unit": "Seconds", + "limit": -1, + "currentValue": 3157 + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountsList.json new file mode 100644 index 000000000000..4a0eed2d16d1 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountsList.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1", + "name": "contoso-testBaseAccount1", + "type": "Microsoft.TestBase/testBaseAccounts", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "S0", + "tier": "Standard", + "capabilities": [ + { + "name": "SLA", + "value": "99.9%" + }, + { + "name": "maximumPackageCount", + "value": "5" + }, + { + "name": "packageMaximumRunSeconds", + "value": "3600" + } + ] + }, + "accessLevel": "EarlyAccess" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg2/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount2", + "name": "contoso-testBaseAccount2", + "type": "Microsoft.TestBase/testBaseAccounts", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "S0", + "tier": "Standard", + "capabilities": [ + { + "name": "SLA", + "value": "99.999%" + }, + { + "name": "maximumPackageCount", + "value": "100" + }, + { + "name": "packageMaximumRunSeconds", + "value": "10800" + } + ] + }, + "accessLevel": "EarlyAccess" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountsListBySubscription.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountsListBySubscription.json new file mode 100644 index 000000000000..6dffdccdbb6a --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestBaseAccountsListBySubscription.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1", + "name": "contoso-testBaseAccount1", + "type": "Microsoft.TestBase/testBaseAccounts", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "S0", + "tier": "Standard", + "capabilities": [ + { + "name": "SLA", + "value": "99.9%" + }, + { + "name": "maximumPackageCount", + "value": "5" + }, + { + "name": "packageMaximumRunSeconds", + "value": "3600" + } + ] + }, + "accessLevel": "EarlyAccess" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg2/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount2", + "name": "contoso-testBaseAccount2", + "type": "Microsoft.TestBase/testBaseAccounts", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "S0", + "tier": "Standard", + "capabilities": [ + { + "name": "SLA", + "value": "99.999%" + }, + { + "name": "maximumPackageCount", + "value": "100" + }, + { + "name": "packageMaximumRunSeconds", + "value": "10800" + } + ] + }, + "accessLevel": "EarlyAccess" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGet.json new file mode 100644 index 000000000000..f0794069bc97 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-99b1f80d-03a9-4148-997f-806ba5bac8e0", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "Windows-10-1909-99b1f80d-03a9-4148-997f-806ba5bac8e0", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-1909-99b1f80d-03a9-4148-997f-806ba5bac8e0", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults", + "properties": { + "baselineTestResultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/anotherId", + "packageId": "b5ed1bcc-e74c-40d8-82f2-1773f616f93e", + "applicationName": "contoso-package2", + "applicationVersion": "1.0.0", + "osName": "Windows 10 1909", + "releaseName": "2020.12B", + "releaseVersionDate": "2020-12-28T17:30:00Z", + "buildRevision": "505", + "testType": "Out of box test", + "testRunTime": "00:21:30", + "isDownloadDataAvailable": true, + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "kbNumber": "KB1984839", + "interopMediaType": "Office", + "interopMediaVersion": "1.0.0.0", + "packageVersion": "3.0.1", + "analysisSummaries": [ + { + "name": "Memory Regression Analysis Result", + "analysisStatus": "Succeeded", + "grade": "Pass" + }, + { + "name": "CPU Regression Analysis Result", + "analysisStatus": "Succeeded", + "grade": "Pass" + }, + { + "name": "Memory Utilization Analysis Result", + "analysisStatus": "Succeeded", + "grade": "Pass" + }, + { + "name": "CPU Utilization Analysis Result", + "analysisStatus": "Succeeded", + "grade": "Pass" + } + ] + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGetConsoleLogDownloadURL.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGetConsoleLogDownloadURL.json new file mode 100644 index 000000000000..f94252a7b8ff --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGetConsoleLogDownloadURL.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-99b1f80d-03a9-4148-997f-806ba5bac8e0", + "api-version": "2023-11-01-preview", + "parameters": { + "logFileName": "launch-stderr-1234.log" + } + }, + "responses": { + "200": { + "body": { + "downloadUrl": "console log download URL", + "expirationTime": "2021-01-10T06:00:00Z" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGetDownloadURL.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGetDownloadURL.json new file mode 100644 index 000000000000..4703272f2611 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGetDownloadURL.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-99b1f80d-03a9-4148-997f-806ba5bac8e0", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "downloadUrl": "test result download URL", + "expirationTime": "2021-01-10T06:00:00Z" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGetVideoDownloadURL.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGetVideoDownloadURL.json new file mode 100644 index 000000000000..91d31ec1f932 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultGetVideoDownloadURL.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "testResultName": "Windows-10-1909-99b1f80d-03a9-4148-997f-806ba5bac8e0", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "downloadUrl": "test result video download URL", + "expirationTime": "2021-01-10T06:00:00Z" + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultsList.json new file mode 100644 index 000000000000..004a9de4387c --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestResultsList.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "packageName": "contoso-package2", + "osUpdateType": "SecurityUpdate", + "$filter": "osName eq 'Windows 10 2004' and releaseName eq '2020.11B'", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Windows-10-2004-8e8e3200-284b-4a99-8c30-cb46c54d4c1e", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-2004-8e8e3200-284b-4a99-8c30-cb46c54d4c1e", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults", + "properties": { + "baselineTestResultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/anotherId", + "packageId": "b5ed1bcc-e74c-40d8-82f2-1773f616f93e", + "applicationName": "contoso-package2", + "applicationVersion": "1.0.0", + "osName": "Windows 10 2004", + "releaseName": "2020.11B", + "releaseVersionDate": "2020-11-28T17:30:00Z", + "buildRevision": "478", + "testType": "Out of box test", + "testRunTime": "00:21:30", + "isDownloadDataAvailable": true, + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "kbNumber": "KB1984839", + "interopMediaType": "Office", + "interopMediaVersion": "1.0.0.0", + "packageVersion": "3.0.1", + "analysisSummaries": [ + { + "name": "Memory Regression Analysis Result", + "analysisStatus": "Succeeded", + "grade": "Pass" + }, + { + "name": "CPU Regression Analysis Result", + "analysisStatus": "Succeeded", + "grade": "Pass" + }, + { + "name": "Memory Utilization Analysis Result", + "analysisStatus": "Succeeded", + "grade": "Pass" + }, + { + "name": "CPU Utilization Analysis Result", + "analysisStatus": "Succeeded", + "grade": "Pass" + } + ] + } + }, + { + "name": "Windows-10-2004-d19baae0-9ab4-432b-a752-878343fa4481", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/Windows-10-2004-d19baae0-9ab4-432b-a752-878343fa4481", + "type": "Microsoft.TestBase/testBaseAccounts/packages/testResults", + "properties": { + "baselineTestResultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/anotherId", + "packageId": "b5ed1bcc-e74c-40d8-82f2-1773f616f93e", + "applicationName": "contoso-package2", + "applicationVersion": "1.0.0", + "osName": "Windows 10 2004", + "releaseName": "2020.11B", + "releaseVersionDate": "2020-11-28T17:30:00Z", + "buildRevision": "309", + "testType": "Out of box test", + "testRunTime": "01:00:00", + "isDownloadDataAvailable": false, + "executionStatus": "Failed", + "testStatus": "TestFailure", + "grade": "Fail", + "kbNumber": "KB1784831", + "interopMediaType": "Office", + "interopMediaVersion": "1.0.0.0", + "packageVersion": "3.0.1", + "analysisSummaries": [ + { + "name": "Memory Regression Analysis Result", + "analysisStatus": "NotAvailable", + "grade": "NotAvailable" + }, + { + "name": "CPU Regression Analysis Result", + "analysisStatus": "NotAvailable", + "grade": "NotAvailable" + }, + { + "name": "Memory Utilization Analysis Result", + "analysisStatus": "NotAvailable", + "grade": "NotAvailable" + }, + { + "name": "CPU Utilization Analysis Result", + "analysisStatus": "NotAvailable", + "grade": "NotAvailable" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestSummariesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestSummariesList.json new file mode 100644 index 000000000000..eb6fc5e0509b --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestSummariesList.json @@ -0,0 +1,250 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contoso-package1-38960b32-3541-4cf1-8ccc-fd22774395cc", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/testSummaries/contoso-package1-38960b32-3541-4cf1-8ccc-fd22774395cc", + "type": "Microsoft.TestBase/testBaseAccounts/testSummaries", + "properties": { + "testSummaryId": "38960b32-3541-4cf1-8ccc-fd22774395cc", + "packageId": "57199102-9738-42e0-9fec-db7709d62a71", + "applicationName": "contoso-package1", + "applicationVersion": "1.0.0", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "packageTags": { + "Tag1": "Tag1Value", + "Tag2": "Tag2Value" + }, + "featureUpdatesTestSummary": { + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:33:21", + "osUpdateTestSummaries": [ + { + "osName": "Windows 10 1909", + "releaseName": "2020.12.B", + "buildVersion": "513", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "testType": "OutOfBoxTest" + }, + { + "osName": "Windows 10 1903", + "releaseName": "2020.11.B", + "buildVersion": "765", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:13:28", + "testType": "OutOfBoxTest" + }, + { + "osName": "Windows 10 1809", + "releaseName": "2020.11.B", + "buildVersion": "313", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:42:08", + "testType": "OutOfBoxTest" + } + ] + }, + "securityUpdatesTestSummary": { + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "osUpdateTestSummaries": [ + { + "osName": "Windows 10 1909", + "releaseName": "2020.12.B", + "buildVersion": "513", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "testType": "OutOfBoxTest" + }, + { + "osName": "Windows 10 1903", + "releaseName": "2020.11.B", + "buildVersion": "765", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:13:28", + "testType": "OutOfBoxTest" + }, + { + "osName": "Windows 10 1809", + "releaseName": "2020.11.B", + "buildVersion": "313", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:42:08", + "testType": "OutOfBoxTest" + } + ] + } + } + }, + { + "name": "contoso-package2-096bffb5-5d3d-4305-a66a-953372ed6e88", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/testSummaries/contoso-package2-096bffb5-5d3d-4305-a66a-953372ed6e88", + "type": "Microsoft.TestBase/testBaseAccounts/testSummaries", + "properties": { + "testSummaryId": "096bffb5-5d3d-4305-a66a-953372ed6e88", + "packageId": "b5ed1bcc-e74c-40d8-82f2-1773f616f93e", + "applicationName": "contoso-package2", + "applicationVersion": "1.0.0", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "packageTags": { + "Tag1": "Tag1Value" + }, + "featureUpdatesTestSummary": { + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:33:21", + "osUpdateTestSummaries": [ + { + "osName": "Windows 10 1909", + "releaseName": "2020.12.B", + "buildVersion": "513", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "testType": "FunctionalTest" + }, + { + "osName": "Windows 10 1903", + "releaseName": "2020.11.B", + "buildVersion": "765", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:13:28", + "testType": "FunctionalTest" + }, + { + "osName": "Windows 10 1809", + "releaseName": "2020.11.B", + "buildVersion": "313", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:42:08", + "testType": "FunctionalTest" + } + ] + }, + "securityUpdatesTestSummary": { + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "osUpdateTestSummaries": [ + { + "osName": "Windows 10 1909", + "releaseName": "2020.12.B", + "buildVersion": "513", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "testType": "FunctionalTest" + }, + { + "osName": "Windows 10 1903", + "releaseName": "2020.11.B", + "buildVersion": "765", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:13:28", + "testType": "FunctionalTest" + }, + { + "osName": "Windows 10 1809", + "releaseName": "2020.11.B", + "buildVersion": "313", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:42:08", + "testType": "FunctionalTest" + } + ] + } + } + }, + { + "name": "contoso-package3-096bffb5-5d3d-4305-a66a-953372ed6e88", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/testSummaries/contoso-package2-096bffb5-5d3d-4305-a66a-953372ed6e89", + "type": "Microsoft.TestBase/testBaseAccounts/testSummaries", + "properties": { + "testSummaryId": "096bffb5-5d3d-4305-a66a-953372ed6e89", + "packageId": "b5ed1bcc-e74c-40d8-82f2-1773f616f93f", + "applicationName": "contoso-package3", + "applicationVersion": "1.0.0", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "packageTags": { + "Tag1": "Tag1Value" + }, + "inplaceUpgradesTestSummary": { + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:33:21", + "osUpdateTestSummaries": [ + { + "osName": "Windows 10 1909", + "releaseName": "2020.12.B", + "buildVersion": "513", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "testType": "FlowDrivenTest", + "inplaceUpgradeBaselineProperties": { + "osName": "Windows 10 1909", + "releaseProperties": { + "releaseName": "2020.11.B", + "buildNumber": "18963", + "buildRevision": "309", + "releaseVersionDate": "2020-11-28T17:30:00Z" + } + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestSummaryGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestSummaryGet.json new file mode 100644 index 000000000000..666c88e7fb53 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestSummaryGet.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "testSummaryName": "contoso-package2-096bffb5-5d3d-4305-a66a-953372ed6e88", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "contoso-package2-096bffb5-5d3d-4305-a66a-953372ed6e88", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/testSummaries/contoso-package2-096bffb5-5d3d-4305-a66a-953372ed6e88", + "type": "Microsoft.TestBase/testBaseAccounts/testSummaries", + "properties": { + "testSummaryId": "096bffb5-5d3d-4305-a66a-953372ed6e88", + "packageId": "b5ed1bcc-e74c-40d8-82f2-1773f616f93e", + "applicationName": "contoso-package2", + "applicationVersion": "1.0.0", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "packageTags": { + "Tag1": "Tag1Value", + "Tag2": "Tag2Value" + }, + "featureUpdatesTestSummary": { + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:33:21", + "osUpdateTestSummaries": [ + { + "osName": "Windows 10 1909", + "releaseName": "2020.12.B", + "buildVersion": "513", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "testType": "OutOfBoxTest" + }, + { + "osName": "Windows 10 1903", + "releaseName": "2020.11.B", + "buildVersion": "765", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:13:28", + "testType": "OutOfBoxTest" + }, + { + "osName": "Windows 10 1809", + "releaseName": "2020.11.B", + "buildVersion": "313", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:42:08", + "testType": "OutOfBoxTest" + } + ] + }, + "securityUpdatesTestSummary": { + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "osUpdateTestSummaries": [ + { + "osName": "Windows 10 1909", + "releaseName": "2020.12.B", + "buildVersion": "513", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:43:21", + "testType": "OutOfBoxTest" + }, + { + "osName": "Windows 10 1903", + "releaseName": "2020.11.B", + "buildVersion": "765", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:13:28", + "testType": "OutOfBoxTest" + }, + { + "osName": "Windows 10 1809", + "releaseName": "2020.11.B", + "buildVersion": "313", + "executionStatus": "Succeeded", + "testStatus": "Completed", + "grade": "Pass", + "testRunTime": "00:42:08", + "testType": "OutOfBoxTest" + } + ] + } + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestTypeGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestTypeGet.json new file mode 100644 index 000000000000..df9b5a9620a3 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestTypeGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "testTypeResourceName": "Functional-Test", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "Functional-Test", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/testTypes/Functional-Test", + "type": "Microsoft.TestBase/testBaseAccounts/testTypes", + "properties": { + "actualTestTypeName": "Functional Test" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestTypesList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestTypesList.json new file mode 100644 index 000000000000..51a78d06b9b9 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/TestTypesList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg", + "testBaseAccountName": "contoso-testBaseAccount", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Functional-Test", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/testTypes/Functional-Test", + "type": "Microsoft.TestBase/testBaseAccounts/testTypes", + "properties": { + "actualTestTypeName": "Functional Test" + } + }, + { + "name": "Out-of-Box-Test", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/testTypes/Out-of-Box-Test", + "type": "Microsoft.TestBase/testBaseAccounts/testTypes", + "properties": { + "actualTestTypeName": "Out of Box Test" + } + }, + { + "name": "Flow-Driven-Test", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount/testTypes/Flow-Driven-Test", + "type": "Microsoft.TestBase/testBaseAccounts/testTypes", + "properties": { + "actualTestTypeName": "Flow Driven Test" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/VHDDelete.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/VHDDelete.json new file mode 100644 index 000000000000..0e64287d9b0b --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/VHDDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "vhdName": "vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/VHDGet.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/VHDGet.json new file mode 100644 index 000000000000..423eebf9de45 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/VHDGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "vhdName": "vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/VHDs/vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "type": "Microsoft.TestBase/testBaseAccounts/VHDs", + "properties": { + "path": "containerId/orgId/vhdPath", + "fileName": "contoso-vhd.vhd", + "fileSize": 136365211648, + "status": "Ready", + "creationTime": "2023-05-09T17:30:00Z" + } + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/VHDsList.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/VHDsList.json new file mode 100644 index 000000000000..9652a855c858 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/examples/VHDsList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso-rg1", + "testBaseAccountName": "contoso-testBaseAccount1", + "api-version": "2023-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/VHDs/vhd-00ac3ccd-1503-4ee5-aa26-26569cfafe88", + "type": "Microsoft.TestBase/testBaseAccounts/VHDs", + "properties": { + "path": "containerId/orgId/vhdPath", + "fileName": "contoso-vhd.vhd", + "fileSize": 136365211648, + "status": "Ready", + "creationTime": "2023-05-09T17:30:00Z" + } + } + ] + } + } + } +} diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/testbase.json b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/testbase.json new file mode 100644 index 000000000000..2bc4393995d0 --- /dev/null +++ b/specification/testbase/resource-manager/Microsoft.TestBase/preview/2023-11-01-preview/testbase.json @@ -0,0 +1,6544 @@ +{ + "swagger": "2.0", + "info": { + "title": "Test Base", + "description": "Test Base", + "version": "2023-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/freeHourBalances": { + "get": { + "tags": [ + "Free Hour Balances" + ], + "operationId": "FreeHourBalances_List", + "summary": "List all the free hour balances of a test base account. The result collection will only contain one element as all the data will be nested in a singleton object.", + "description": "Return the Test Base free hour balances list.", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succeeded to list the Test Base free hour balances.", + "schema": { + "$ref": "#/definitions/FreeHourBalancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FreeHourBalancesList": { + "$ref": "./examples/FreeHourBalancesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/freeHourBalances/{freeHourBalanceName}": { + "get": { + "tags": [ + "Free Hour Balances" + ], + "operationId": "FreeHourBalances_Get", + "summary": "Get the free hour balance of a test base account.", + "description": "Return the Test Base free hour balance.", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/FreeHourBalanceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succeeded to get the Test Base free hour balance.", + "schema": { + "$ref": "#/definitions/FreeHourBalanceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FreeHourBalanceGet": { + "$ref": "./examples/FreeHourBalanceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.TestBase/skus": { + "get": { + "tags": [ + "test base account" + ], + "operationId": "Skus_List", + "description": "Lists the available SKUs of Test Base Account in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/TestBaseAccountSKUListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TestBaseAccountSKUsList": { + "$ref": "./examples/TestBaseAccountSKUsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.TestBase/testBaseAccounts": { + "get": { + "tags": [ + "Test Base Account" + ], + "operationId": "TestBaseAccounts_ListBySubscription", + "description": "Lists all the Test Base Accounts in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountIncludeSoftDeletedParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/TestBaseAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TestBaseAccountsListBySubscription": { + "$ref": "./examples/TestBaseAccountsListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts": { + "get": { + "tags": [ + "Test Base Account" + ], + "operationId": "TestBaseAccounts_ListByResourceGroup", + "description": "Lists all the Test Base Accounts in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountIncludeSoftDeletedParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/TestBaseAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TestBaseAccountsList": { + "$ref": "./examples/TestBaseAccountsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}": { + "put": { + "tags": [ + "Test Base Account" + ], + "operationId": "TestBaseAccounts_Create", + "description": "Create or replace (overwrite/recreate, with potential downtime) a Test Base Account in the specified subscription.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestBaseAccountResource" + }, + "description": "Parameters supplied to create a Test Base Account." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountRestoreSoftDeletedParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Account was successfully created or updated.", + "schema": { + "$ref": "#/definitions/TestBaseAccountResource" + } + }, + "201": { + "description": "The Test Base Account 'create' or 'update' operation was successfully enqueued. Check provisioningState to see detailed status.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/TestBaseAccountResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestBaseAccountCreate": { + "$ref": "./examples/TestBaseAccountCreate.json" + } + } + }, + "patch": { + "tags": [ + "Test Base Account" + ], + "operationId": "TestBaseAccounts_Update", + "description": "Update an existing Test Base Account.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestBaseAccountUpdateParameters" + }, + "description": "Parameters supplied to update a Test Base Account." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The existing Test Base Account was successfully updated.", + "schema": { + "$ref": "#/definitions/TestBaseAccountResource" + } + }, + "201": { + "description": "The Test Base Account 'update' operation was successfully enqueued. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "202": { + "description": "The Test Base Account 'update' operation was successfully enqueued. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "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-examples": { + "TestBaseAccountUpdate": { + "$ref": "./examples/TestBaseAccountUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Test Base Account" + ], + "operationId": "TestBaseAccounts_Delete", + "description": "Deletes a Test Base Account.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Account 'delete' operation was completed successfully." + }, + "202": { + "description": "The Test Base Account 'delete' operation was successfully enqueued. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "The Test Base Account 'delete' operation was completed successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestBaseAccountDelete": { + "$ref": "./examples/TestBaseAccountDelete.json" + } + } + }, + "get": { + "tags": [ + "Test Base Account" + ], + "operationId": "TestBaseAccounts_Get", + "description": "Gets a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Account was successfully found.", + "schema": { + "$ref": "#/definitions/TestBaseAccountResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestBaseAccountGet": { + "$ref": "./examples/TestBaseAccountGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/offboard": { + "post": { + "tags": [ + "Test Base Account" + ], + "operationId": "TestBaseAccounts_Offboard", + "description": "Offboard a Test Base Account.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Account 'offboard' operation was completed successfully." + }, + "202": { + "description": "The Test Base Account 'offboard' operation was successfully enqueued. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "The Test Base Account 'offboard' operation was completed successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestBaseAccountOffboard": { + "$ref": "./examples/TestBaseAccountOffboard.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/usages": { + "get": { + "tags": [ + "Test Base Account" + ], + "operationId": "Usage_List", + "description": "Lists the usage data of a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The usage of the Test Base Account was returned.", + "schema": { + "$ref": "#/definitions/TestBaseAccountUsageDataList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TestBaseAccountUsagesList": { + "$ref": "./examples/TestBaseAccountUsagesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/getFileUploadUrl": { + "post": { + "tags": [ + "Test Base Package" + ], + "operationId": "TestBaseAccounts_GetFileUploadUrl", + "description": "Gets the file upload URL of a Test Base Account.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/GetFileUploadURLParameters" + }, + "description": "Parameters supplied to the Test Base Account GetFileUploadURL operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The file upload URL of the Test Base Account was returned.", + "schema": { + "$ref": "#/definitions/FileUploadURLResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestBaseAccountGetFileUploadUrl": { + "$ref": "./examples/TestBaseAccountGetFileUploadUrl.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/availableOSs": { + "get": { + "tags": [ + "Supported OSes" + ], + "operationId": "AvailableOS_List", + "description": "Lists all the available OSs to run a package under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/OSUpdateTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/AvailableOSListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvailableOSsList": { + "$ref": "./examples/AvailableOSsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/availableOSs/{availableOSResourceName}": { + "get": { + "tags": [ + "Supported OSes" + ], + "operationId": "AvailableOS_Get", + "description": "Gets an available OS to run a package under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "name": "availableOSResourceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of an Available OS." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/AvailableOSResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvailableOSGet": { + "$ref": "./examples/AvailableOSGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/featureUpdateSupportedOses": { + "get": { + "tags": [ + "Supported OSes" + ], + "operationId": "FeatureUpdateSupportedOses_List", + "description": "Lists all the available OSs to run a package under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/FeatureUpdateSupportedOsesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FeatureUpdateSupportedOsesList": { + "$ref": "./examples/FeatureUpdateSupportedOsesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/flightingRings": { + "get": { + "tags": [ + "Test Base Package" + ], + "operationId": "FlightingRings_List", + "description": "Lists all the flighting rings of a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/FlightingRingListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FlightingRingsList": { + "$ref": "./examples/FlightingRingsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/flightingRings/{flightingRingResourceName}": { + "get": { + "tags": [ + "Test Base Package" + ], + "operationId": "FlightingRings_Get", + "description": "Gets a flighting ring of a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "name": "flightingRingResourceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of a flighting ring." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/FlightingRingResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FlightingRingGet": { + "$ref": "./examples/FlightingRingGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/firstPartyApps": { + "get": { + "tags": [ + "First Party Applications" + ], + "operationId": "FirstPartyApps_List", + "description": "Lists all first party applications currently available for test runs under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/FirstPartyAppListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FirstPartyAppsList": { + "$ref": "./examples/FirstPartyAppsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/firstPartyApps/{firstPartyAppResourceName}": { + "get": { + "tags": [ + "First Party Applications" + ], + "operationId": "FirstPartyApps_Get", + "description": "Gets a first party application to prepare a test run for a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "name": "firstPartyAppResourceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of a first party application.", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9]|(-[A-Za-z0-9]))+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/FirstPartyAppResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FirstPartyAppsGet": { + "$ref": "./examples/FirstPartyAppGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/galleryApps": { + "get": { + "tags": [ + "Gallery Applications" + ], + "operationId": "GalleryApps_List", + "description": "Lists all gallery applications currently available for test runs under a Test Base Account which matches user query.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/KeywordParameter" + }, + { + "name": "applicationType", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "Winget" + ], + "x-ms-enum": { + "name": "applicationType", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "The type of the gallery application." + }, + { + "name": "orderBy", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "popularity", + "relevance" + ], + "x-ms-enum": { + "name": "orderBy", + "modelAsString": true + }, + "default": "relevance", + "x-ms-parameter-location": "method", + "description": "The order of result list." + }, + { + "$ref": "#/parameters/TopFilter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/GalleryAppListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GalleryAppsList": { + "$ref": "./examples/GalleryAppsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/galleryApps/{galleryAppName}": { + "get": { + "tags": [ + "Gallery Applications" + ], + "operationId": "GalleryApps_Get", + "description": "Gets a gallery application to prepare a test run for a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/GalleryAppNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/GalleryAppResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GalleryAppsGet": { + "$ref": "./examples/GalleryAppGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/galleryApps/{galleryAppName}/galleryAppSkus": { + "get": { + "tags": [ + "Gallery Applications" + ], + "operationId": "GalleryAppSkus_List", + "description": "Lists all SKUs of a gallery application currently available for test runs under a Test Base account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/GalleryAppNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/GalleryAppSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GalleryAppSkusList": { + "$ref": "./examples/GalleryAppsSkusList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/galleryApps/{galleryAppName}/galleryAppSkus/{galleryAppSkuName}": { + "get": { + "tags": [ + "Gallery Applications" + ], + "operationId": "GalleryAppSkus_Get", + "description": "Gets a gallery application SKU for test runs under a Test Base account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/GalleryAppNameParameter" + }, + { + "name": "galleryAppSkuName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of a gallery application SKU.", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9]|(-[A-Za-z0-9]))+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/GalleryAppSkuResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GalleryAppsSkuGet": { + "$ref": "./examples/GalleryAppSkuGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/testTypes": { + "get": { + "tags": [ + "Test Base Package" + ], + "operationId": "TestTypes_List", + "description": "Lists all the test types of a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/TestTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TestTypesList": { + "$ref": "./examples/TestTypesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/testTypes/{testTypeResourceName}": { + "get": { + "tags": [ + "Test Base Package" + ], + "operationId": "TestTypes_Get", + "description": "Gets a test type of a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "name": "testTypeResourceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of a test type." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/TestTypeResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestTypeGet": { + "$ref": "./examples/TestTypeGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/checkPackageNameAvailability": { + "post": { + "tags": [ + "Test Base Package" + ], + "operationId": "TestBaseAccounts_CheckPackageNameAvailability", + "description": "Checks that the Test Base Package name and version is valid and is not already in use.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PackageCheckNameAvailabilityParameters" + }, + "description": "Parameters supplied to the Test Base Package CheckNameAvailability operation." + } + ], + "responses": { + "200": { + "description": "Name is available", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckPackageNameAvailability": { + "$ref": "./examples/CheckPackageNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages": { + "get": { + "tags": [ + "Test Base Package" + ], + "operationId": "Packages_ListByTestBaseAccount", + "description": "Lists all the packages under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/PackageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PackagesList": { + "$ref": "./examples/PackagesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}": { + "put": { + "tags": [ + "Test Base Package" + ], + "operationId": "Packages_Create", + "description": "Create or replace (overwrite/recreate, with potential downtime) a Test Base Package.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PackageResource" + }, + "description": "Parameters supplied to create a Test Base Package." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Package was successfully created or updated.", + "schema": { + "$ref": "#/definitions/PackageResource" + } + }, + "201": { + "description": "The Test Base Package 'create' or 'update' operation was successfully enqueued. Check provisioningState to see detailed status.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/PackageResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PackageCreate": { + "$ref": "./examples/PackageCreate.json" + } + } + }, + "patch": { + "tags": [ + "Test Base Package" + ], + "operationId": "Packages_Update", + "description": "Update an existing Test Base Package.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PackageUpdateParameters" + }, + "description": "Parameters supplied to update a Test Base Package." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The existing Test Base Package was successfully updated. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/PackageResource" + } + }, + "201": { + "description": "The Test Base Package 'update' operation was successfully enqueued. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "202": { + "description": "The Test Base Package 'update' operation was successfully enqueued. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "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-examples": { + "PackageUpdate": { + "$ref": "./examples/PackageUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Test Base Package" + ], + "operationId": "Packages_Delete", + "description": "Deletes a Test Base Package.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Package 'delete' operation was completed successfully." + }, + "202": { + "description": "The Test Base Package 'delete' operation was successfully enqueued. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "The Test Base Package 'delete' operation was completed successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PackageDelete": { + "$ref": "./examples/PackageDelete.json" + } + } + }, + "get": { + "tags": [ + "Test Base Package" + ], + "operationId": "Packages_Get", + "description": "Gets a Test Base Package.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Package was successfully found.", + "schema": { + "$ref": "#/definitions/PackageResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PackageGet": { + "$ref": "./examples/PackageGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/hardDelete": { + "post": { + "tags": [ + "Test Base Package" + ], + "operationId": "Packages_HardDelete", + "description": "Hard Delete a Test Base Package.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Package 'HardDelete' operation was completed successfully." + }, + "202": { + "description": "The Test Base Package 'HardDelete' operation was successfully enqueued. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "The Test Base Package 'HardDelete' operation was completed successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PackageHardDelete": { + "$ref": "./examples/PackageHardDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/getDownloadUrl": { + "post": { + "tags": [ + "Test Base Package" + ], + "operationId": "Packages_GetDownloadURL", + "description": "Gets the download URL of a package.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The package download URL is returned.", + "schema": { + "$ref": "#/definitions/DownloadURLResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PackageGetDownloadURL": { + "$ref": "./examples/PackageGetDownloadURL.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/runTest": { + "post": { + "tags": [ + "Test Base Package" + ], + "operationId": "Packages_RunTest", + "description": "Trigger a test run on the package.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/PackageRunTestParameters" + }, + "description": "The parameters supplied to the Test Base Package to start a Test Run." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The test is triggered successfully." + }, + "202": { + "description": "The request to trigger a test was accepted. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "The test is triggered successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PackageRunTest": { + "$ref": "./examples/PackageRunTest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/testSummaries": { + "get": { + "tags": [ + "Test Result" + ], + "operationId": "TestSummaries_List", + "description": "Lists the Test Summaries of all the packages under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/TestSummaryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TestSummariesList": { + "$ref": "./examples/TestSummariesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/testSummaries/{testSummaryName}": { + "get": { + "tags": [ + "Test Result" + ], + "operationId": "TestSummaries_Get", + "description": "Gets a Test Summary with specific name from all the Test Summaries of all the packages under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "name": "testSummaryName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the Test Summary." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/TestSummaryResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestSummaryGet": { + "$ref": "./examples/TestSummaryGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/testResults": { + "get": { + "tags": [ + "Test Result" + ], + "operationId": "TestResults_List", + "description": "Lists all the Test Results with specified OS Update type for a Test Base Package. Can be filtered by osName, releaseName, flightingRing, buildVersion, buildRevision.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/OSUpdateTypeParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/TestResultListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TestResultsList": { + "$ref": "./examples/TestResultsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/testResults/{testResultName}": { + "get": { + "tags": [ + "Test Result" + ], + "operationId": "TestResults_Get", + "description": "Get the Test Result by Id with specified OS Update type for a Test Base Package.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/TestResultNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/TestResultResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestResultGet": { + "$ref": "./examples/TestResultGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/osUpdates": { + "get": { + "tags": [ + "Test Result" + ], + "operationId": "OSUpdates_List", + "description": "Lists the OS Updates in which the package were tested before.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/OSUpdateTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/OSUpdateListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OSUpdatesList": { + "$ref": "./examples/OSUpdatesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/osUpdates/{osUpdateResourceName}": { + "get": { + "tags": [ + "Test Result" + ], + "operationId": "OSUpdates_Get", + "description": "Gets an OS Update by name in which the package was tested before.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "name": "osUpdateResourceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of an OS Update." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/OSUpdateResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OSUpdateGet": { + "$ref": "./examples/OSUpdateGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/favoriteProcesses": { + "get": { + "tags": [ + "Test Result" + ], + "operationId": "FavoriteProcesses_List", + "description": "Lists the favorite processes for a specific package.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/FavoriteProcessListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FavoriteProcessesList": { + "$ref": "./examples/FavoriteProcessesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/favoriteProcesses/{favoriteProcessResourceName}": { + "put": { + "tags": [ + "Test Result" + ], + "operationId": "FavoriteProcesses_Create", + "description": "Create or replace a favorite process for a Test Base Package.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FavoriteProcessResource" + }, + "description": "Parameters supplied to create a favorite process in a package." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/FavoriteProcessResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The favorite processes was successfully created or updated.", + "schema": { + "$ref": "#/definitions/FavoriteProcessResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FavoriteProcessCreate": { + "$ref": "./examples/FavoriteProcessCreate.json" + } + } + }, + "delete": { + "tags": [ + "Test Result" + ], + "operationId": "FavoriteProcesses_Delete", + "description": "Deletes a favorite process for a specific package.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/FavoriteProcessResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The package favorite process 'delete' operation was completed successfully." + }, + "204": { + "description": "The package favorite process 'delete' operation was completed successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FavoriteProcessDelete": { + "$ref": "./examples/FavoriteProcessDelete.json" + } + } + }, + "get": { + "tags": [ + "Test Result" + ], + "operationId": "FavoriteProcesses_Get", + "description": "Gets a favorite process for a Test Base Package.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/FavoriteProcessResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/FavoriteProcessResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FavoriteProcessGet": { + "$ref": "./examples/FavoriteProcessGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/testResults/{testResultName}/analysisResults": { + "get": { + "tags": [ + "Test Result" + ], + "operationId": "AnalysisResults_List", + "description": "Lists the Analysis Results of a Test Result. The result collection will only contain one element as all the data will be nested in a singleton object.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/TestResultNameParameter" + }, + { + "$ref": "#/parameters/AnalysisResultTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/AnalysisResultListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ScriptExecutionAnalysisResultsList": { + "$ref": "./examples/ScriptExecutionAnalysisResultsList.json" + }, + "MemoryUtilizationAnalysisResultsList": { + "$ref": "./examples/MemoryUtilizationAnalysisResultsList.json" + }, + "CPUUtilizationAnalysisResultsList": { + "$ref": "./examples/CPUUtilizationAnalysisResultsList.json" + }, + "MemoryRegressionAnalysisResultsList": { + "$ref": "./examples/MemoryRegressionAnalysisResultsList.json" + }, + "CPURegressionAnalysisResultsList": { + "$ref": "./examples/CPURegressionAnalysisResultsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/testResults/{testResultName}/analysisResults/{analysisResultName}": { + "get": { + "tags": [ + "Test Result" + ], + "operationId": "AnalysisResults_Get", + "description": "Gets an Analysis Result of a Test Result by name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/TestResultNameParameter" + }, + { + "$ref": "#/parameters/AnalysisResultNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/AnalysisResultSingletonResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScriptExecutionAnalysisResultGet": { + "$ref": "./examples/ScriptExecutionAnalysisResultGet.json" + }, + "MemoryUtilizationAnalysisResultGet": { + "$ref": "./examples/MemoryUtilizationAnalysisResultGet.json" + }, + "CPUUtilizationAnalysisResultGet": { + "$ref": "./examples/CPUUtilizationAnalysisResultGet.json" + }, + "MemoryRegressionAnalysisResultGet": { + "$ref": "./examples/MemoryRegressionAnalysisResultGet.json" + }, + "CPURegressionAnalysisResultGet": { + "$ref": "./examples/CPURegressionAnalysisResultGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/testResults/{testResultName}/getDownloadUrl": { + "post": { + "tags": [ + "Test Result" + ], + "operationId": "TestResults_GetDownloadURL", + "description": "Gets the download URL of the test result.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/TestResultNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/DownloadURLResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestResultGetDownloadURL": { + "$ref": "./examples/TestResultGetDownloadURL.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/testResults/{testResultName}/getVideoDownloadUrl": { + "post": { + "tags": [ + "Test Result" + ], + "operationId": "TestResults_GetVideoDownloadURL", + "description": "Gets the download URL of the test execution screen recording.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/TestResultNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/DownloadURLResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestResultGetVideoDownloadURL": { + "$ref": "./examples/TestResultGetVideoDownloadURL.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/testResults/{testResultName}/getConsoleLogDownloadUrl": { + "post": { + "tags": [ + "Test Result" + ], + "operationId": "TestResults_GetConsoleLogDownloadURL", + "description": "Gets the download URL of the test execution console log file.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/PackageNameParameter" + }, + { + "$ref": "#/parameters/TestResultNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestResultConsoleLogDownloadURLParameters" + }, + "description": "Parameters supplied to the Test Result GetConsoleLogDownloadUrl operation." + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/DownloadURLResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TestResultGetConsoleLogDownloadURL": { + "$ref": "./examples/TestResultGetConsoleLogDownloadURL.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/emailEvents": { + "get": { + "tags": [ + "Test Base Email Event" + ], + "operationId": "EmailEvents_List", + "description": "Lists all the email events of a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/EmailEventListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EmailEventsList": { + "$ref": "./examples/EmailEventsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/emailEvents/{emailEventResourceName}": { + "get": { + "tags": [ + "Test Base Email Event" + ], + "operationId": "EmailEvents_Get", + "description": "Gets a email event of a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "name": "emailEventResourceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of an email event." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/EmailEventResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EmailEventGet": { + "$ref": "./examples/EmailEventGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/customerEvents": { + "get": { + "tags": [ + "Test Base Customer Notification Events" + ], + "operationId": "CustomerEvents_ListByTestBaseAccount", + "description": "Lists all notification events subscribed under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/CustomerEventListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CustomerEventsList": { + "$ref": "./examples/CustomerEventsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/customerEvents/{customerEventName}": { + "put": { + "tags": [ + "Test Base Customer Event" + ], + "operationId": "CustomerEvents_Create", + "description": "Create or replace a Test Base Customer Event.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CustomerEventResource" + }, + "description": "Parameters supplied to create a Test Base CustomerEvent." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CustomerEventNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Customer Event was successfully created or updated.", + "schema": { + "$ref": "#/definitions/CustomerEventResource" + } + }, + "201": { + "description": "The Test Base Customer Event 'create' or 'update' operation was successfully enqueued. Check provisioningState to see detailed status.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomerEventResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomerEventCreate": { + "$ref": "./examples/CustomerEventCreate.json" + } + } + }, + "delete": { + "tags": [ + "Test Base Customer Event" + ], + "operationId": "CustomerEvents_Delete", + "description": "Deletes a Test Base Customer Event.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CustomerEventNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Customer Event 'delete' operation was completed successfully." + }, + "202": { + "description": "The Test Base Customer Event 'delete' operation was successfully enqueued. Follow the Location header to poll for final outcome.", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "The Test Base Customer Event 'delete' operation was completed successfully." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomerEventDelete": { + "$ref": "./examples/CustomerEventDelete.json" + } + } + }, + "get": { + "tags": [ + "Test Base Customer Event" + ], + "operationId": "CustomerEvents_Get", + "description": "Gets a Test Base CustomerEvent.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/CustomerEventNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Test Base Customer Event was successfully found.", + "schema": { + "$ref": "#/definitions/CustomerEventResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomerEventGet": { + "$ref": "./examples/CustomerEventGet.json" + } + } + } + }, + "/providers/Microsoft.TestBase/operations": { + "get": { + "tags": [ + "Operation" + ], + "description": "Lists all of the available REST API operations of the Microsoft.TestBase provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/getFreeHourBalance": { + "post": { + "operationId": "BillingHubService_GetFreeHourBalance", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/BillingHubGetFreeHourBalanceResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "BillingHubService" + ], + "x-ms-examples": { + "BillingHubGetFreeHourBalance": { + "$ref": "./examples/BillingHubGetFreeHourBalance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/getUsage": { + "post": { + "operationId": "BillingHubService_GetUsage", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "$ref": "#/definitions/BillingHubGetUsageResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "getUsageRequest", + "in": "body", + "schema": { + "$ref": "#/definitions/BillingHubGetUsageRequest" + } + } + ], + "tags": [ + "BillingHubService" + ], + "x-ms-examples": { + "BillingHubGetUsage": { + "$ref": "./examples/BillingHubGetUsage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/availableInplaceUpgradeOSs": { + "get": { + "tags": [ + "Supported OSes" + ], + "operationId": "AvailableInplaceUpgradeOS_List", + "description": "Lists all the available In-place Upgrade OSs to a package under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "$ref": "#/parameters/OSUpdateTypeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/AvailableInplaceUpgradeOSListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvailableInplaceUpgradeOSList": { + "$ref": "./examples/AvailableInplaceUpgradeOSList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/availableInplaceUpgradeOSs/{availableInplaceUpgradeOSResourceName}": { + "get": { + "tags": [ + "Supported OSes" + ], + "operationId": "AvailableInplaceUpgradeOS_Get", + "description": "Gets an available In-place Upgrade OS to run a package under a Test Base Account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TestBaseAccountNameParameter" + }, + { + "name": "availableInplaceUpgradeOSResourceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of an Available In-place Upgrade OS.", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9_]|(-{1,3}[A-Za-z0-9]))+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation is completed.", + "schema": { + "$ref": "#/definitions/AvailableInplaceUpgradeOSResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvailableInplaceUpgradeOSGet": { + "$ref": "./examples/AvailableInplaceUpgradeOSGet.json" + } + } + } + } + }, + "definitions": { + "Tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "TestBaseAccountSKUListResult": { + "description": "A list of Test Base Account SKUs.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TestBaseAccountSKU" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of Test Base Account SKUs." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "TestBaseAccountSKU": { + "description": "Describes a Test Base Account SKU.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "name": { + "type": "string", + "description": "The name of the SKU. This is typically a letter + number code, such as B0 or S0." + }, + "tier": { + "type": "string", + "description": "The tier of this particular SKU.", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "tier", + "modelAsString": true + } + }, + "capabilities": { + "type": "array", + "description": "The capabilities of a SKU.", + "readOnly": true, + "items": { + "$ref": "#/definitions/TestBaseAccountSKUCapability" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "locations": { + "description": "The locations that the SKU is available.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "tier" + ] + }, + "TestBaseAccountSKUCapability": { + "description": "Properties of the Test Base Account SKU Capability.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "An invariant to describe the feature, such as 'SLA'." + }, + "value": { + "type": "string", + "description": "An invariant if the feature is measured by quantity, such as 99.9%." + } + }, + "required": [ + "name", + "value" + ] + }, + "TestBaseAccountListResult": { + "description": "A list of Test Base Accounts.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TestBaseAccountResource" + }, + "description": "The list of Test Base Accounts." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "TestBaseAccountResource": { + "description": "The Test Base Account resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TestBaseAccountResourceProperties", + "description": "Properties of a Test Base Account." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/SystemAssignedServiceIdentity", + "description": "The identity of the testBaseAccount." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "TestBaseAccountResourceProperties": { + "description": "The properties of a Test Base Account resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "sku": { + "description": "The SKU of the Test Base Account.", + "$ref": "#/definitions/TestBaseAccountSKU" + }, + "accessLevel": { + "description": "The access level of the Test Base Account.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "sku" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property", + "enum": [ + "Succeeded", + "Failed", + "Cancelled", + "Creating", + "Deleting", + "Updating" + ], + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "TestBaseAccountUpdateParameters": { + "description": "Parameters supplied to update a Test Base Account.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestBaseAccountUpdateParameterProperties", + "x-ms-client-flatten": true, + "description": "Test Base Account update parameters." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/SystemAssignedServiceIdentity", + "description": "The identity of the testBaseAccount." + }, + "tags": { + "description": "The tags of the Test Base Account.", + "$ref": "#/definitions/Tags" + } + } + }, + "TestBaseAccountUpdateParameterProperties": { + "description": "Parameters supplied to update a Test Base Account.", + "type": "object", + "properties": { + "sku": { + "description": "The SKU of the Test Base Account.", + "$ref": "#/definitions/TestBaseAccountSKU" + } + } + }, + "TestBaseAccountUsageDataList": { + "description": "A list of Test Base Account usage data.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TestBaseAccountUsageData" + }, + "description": "The list of Test Base Account usage data." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "TestBaseAccountUsageData": { + "description": "The usage data of a Test Base Account.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" + }, + "name": { + "$ref": "#/definitions/TestBaseAccountUsageName", + "description": "Localizable String object containing the name and a localized value." + }, + "unit": { + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", + "type": "string" + }, + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" + }, + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" + } + } + }, + "TestBaseAccountUsageName": { + "description": "Localizable String object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "The identifier of the usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name of the usage.", + "type": "string" + } + } + }, + "GetFileUploadURLParameters": { + "description": "The parameters supplied to the Test Base Account GetFileUploadURL action.", + "type": "object", + "properties": { + "blobName": { + "type": "string", + "description": "The custom file name of the uploaded blob." + }, + "resourceType": { + "type": "string", + "enum": [ + "Package", + "VHD" + ], + "description": "Resource type for file uploading.", + "x-ms-enum": { + "name": "fileUploadResourceType", + "modelAsString": true, + "values": [ + { + "value": "Package", + "description": "Upload file for package onboarding." + }, + { + "value": "VHD", + "description": "Upload VHD file for image onboarding." + } + ] + } + } + } + }, + "FileUploadURLResponse": { + "description": "The URL response", + "type": "object", + "properties": { + "uploadUrl": { + "type": "string", + "readOnly": true, + "description": "The URL used for uploading the package." + }, + "blobPath": { + "type": "string", + "readOnly": true, + "description": "The blob path of the uploaded package. It will be used as the 'blobPath' property of PackageResource." + } + } + }, + "AvailableOSListResult": { + "description": "A list of available OSs.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableOSResource" + }, + "description": "The list of available OSs." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "AvailableOSResource": { + "description": "The Available OS resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AvailableOSProperties", + "x-ms-client-flatten": true, + "description": "Available OS properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvailableOSProperties": { + "description": "The Available OS properties.", + "type": "object", + "properties": { + "osId": { + "type": "string", + "description": "The Id of an Available OS of a Test Base Account." + }, + "osName": { + "type": "string", + "description": "The name of an Available OS of a Test Base Account." + }, + "osVersion": { + "type": "string", + "description": "The version of an Available OS of a Test Base Account." + }, + "insiderChannel": { + "type": "string", + "description": "The insider channel of an Available OS of a Test Base Account." + }, + "osUpdateType": { + "type": "string", + "description": "The OS update type of an Available OS of a Test Base Account." + }, + "osPlatform": { + "type": "string", + "description": "The Platform of an Available OS of a Test Base Account." + } + } + }, + "FeatureUpdateSupportedOsesResult": { + "description": "Response schema of feature update supported OSes list API.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FeatureUpdateSupportedOsesResource" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "FeatureUpdateSupportedOsesResource": { + "description": "Feature update supported OSes proxy resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FeatureUpdateSupportedOsesProperties", + "x-ms-client-flatten": true, + "description": "Available OS properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "FeatureUpdateSupportedOsesProperties": { + "description": "Properties of feature update supported OSes proxy resource.", + "type": "object", + "properties": { + "osId": { + "type": "string" + }, + "osName": { + "type": "string" + }, + "insiderChannel": { + "type": "string" + }, + "version": { + "type": "string" + }, + "displayText": { + "type": "string" + }, + "baselineProducts": { + "type": "array", + "items": { + "type": "string" + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the OS starts to be supported." + }, + "state": { + "type": "string", + "enum": [ + "Disabled", + "Active" + ], + "description": "State of the OS product.", + "x-ms-enum": { + "name": "osProductState", + "modelAsString": true + } + } + }, + "required": [ + "osId", + "osName", + "insiderChannel", + "version", + "baselineProducts", + "startTime", + "state", + "displayText" + ] + }, + "FlightingRingListResult": { + "description": "A list of flighting rings.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FlightingRingResource" + }, + "description": "The list of flighting rings." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "FlightingRingResource": { + "description": "The flighting ring resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FlightingRingProperties", + "x-ms-client-flatten": true, + "description": "Flighting Ring properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "FlightingRingProperties": { + "description": "The Flighting Ring properties.", + "type": "object", + "properties": { + "actualFlightingRingName": { + "type": "string", + "description": "The actual name of a flighting ring of a Test Base Account." + } + } + }, + "FirstPartyAppListResult": { + "description": "A list of currently available first party applications.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirstPartyAppResource" + }, + "description": "The list of currently available first party applications." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "FirstPartyAppResource": { + "description": "The first party application resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FirstPartyAppProperties", + "x-ms-client-flatten": true, + "description": "Properties of a first party application." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "FirstPartyAppProperties": { + "description": "Properties of a first party application.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "mediaType": { + "type": "string", + "description": "The media type of a first party application of a Test Base Account." + }, + "architecture": { + "$ref": "#/definitions/Architecture", + "description": "The architecture of a first party application of a Test Base Account." + }, + "channel": { + "type": "string", + "description": "The channel info of a first party application of a Test Base Account." + }, + "ring": { + "type": "string", + "description": "The ring info of a first party application of a Test Base Account." + }, + "supportedProducts": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The supported OS products of a first party application of a Test Base Account." + } + } + }, + "FirstPartyAppDefinition": { + "description": "Properties of the definition of a first party application of the Test Base package.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The media name of a first party application of a Test Base Account." + }, + "architecture": { + "$ref": "#/definitions/Architecture", + "description": "The architecture of a first party application of a Test Base Account." + }, + "channel": { + "type": "string", + "description": "The channel info of a first party application of a Test Base Account." + }, + "ring": { + "type": "string", + "description": "The ring info of a first party application of a Test Base Account." + }, + "interopExecutionMode": { + "type": "string", + "description": "Specifies how the first party applications should be inter-operated with user's application.", + "enum": [ + "firstPartyAppWithTests", + "firstPartyApp" + ], + "default": "firstPartyAppWithTests", + "x-ms-enum": { + "name": "interopExecutionMode", + "modelAsString": true, + "values": [ + { + "value": "firstPartyAppWithTests", + "description": "User application will test with the first party applications. For out-of-box tests, additional test cases for first party applications will also be run." + }, + { + "value": "firstPartyApp", + "description": "User application will test with the first party applications." + } + ] + } + } + } + }, + "TestResultFirstPartyAppDefinition": { + "description": "Properties of the definition of first party application in test result.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The media name of a first party application of a Test Base Account." + }, + "version": { + "type": "string", + "description": "The media version of a first party application of a Test Base Account." + }, + "architecture": { + "$ref": "#/definitions/Architecture", + "description": "The architecture of a first party application of a Test Base Account." + }, + "channel": { + "type": "string", + "description": "The channel info of a first party application of a Test Base Account." + }, + "ring": { + "type": "string", + "description": "The ring info of a first party application of a Test Base Account." + } + } + }, + "GalleryAppDefinition": { + "description": "Properties of the definition of a gallery application used in Test Base package.", + "type": "object", + "properties": { + "skuId": { + "type": "string", + "description": "The SKU id of the gallery application." + }, + "isConsented": { + "type": "boolean", + "description": "Whether the disclaimer of the gallery application is accepted.", + "default": false + } + }, + "required": [ + "skuId" + ] + }, + "GalleryAppListResult": { + "description": "A list of currently available gallery applications.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryAppResource" + }, + "description": "The list of currently available gallery applications." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "GalleryAppResource": { + "description": "The gallery application resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/GalleryAppProperties", + "x-ms-client-flatten": true, + "description": "Properties of a gallery application." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GalleryAppProperties": { + "description": "Properties of a gallery application.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "applicationType": { + "$ref": "#/definitions/GalleryAppType", + "description": "The application type of a gallery application." + }, + "applicationId": { + "type": "string", + "description": "The id of a gallery application." + }, + "applicationName": { + "type": "string", + "description": "The name of a gallery application." + }, + "popularity": { + "type": "integer", + "format": "int64", + "description": "The number of users using a gallery application.", + "default": 0 + } + }, + "required": [ + "applicationType", + "applicationId", + "applicationName", + "popularity" + ] + }, + "GalleryAppType": { + "description": "The type of a gallery application.", + "type": "string", + "enum": [ + "Winget" + ], + "x-ms-enum": { + "name": "applicationType", + "modelAsString": true + } + }, + "GalleryAppSkuListResult": { + "description": "A list of currently available SKUs of a gallery application.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryAppSkuResource" + }, + "description": "The list of currently available SKUs of a gallery applications." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "GalleryAppSkuResource": { + "description": "The gallery application resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/GalleryAppSkuProperties", + "x-ms-client-flatten": true, + "description": "Properties of a gallery application SKU." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GalleryAppSkuProperties": { + "description": "Properties of a gallery application SKU.", + "type": "object", + "discriminator": "applicationType", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "applicationType": { + "$ref": "#/definitions/GalleryAppType", + "description": "The application type of a gallery application." + } + }, + "required": [ + "applicationType" + ] + }, + "WingetAppSkuProperties": { + "description": "The detailed properties of a winget gallery application SKU.", + "type": "object", + "x-ms-discriminator-value": "Winget", + "properties": { + "version": { + "type": "string", + "description": "The version of a winget gallery application SKU." + }, + "license": { + "type": "string", + "description": "The license description of a winget gallery application SKU." + }, + "licenseUrl": { + "type": "string", + "description": "The license URL of a winget gallery application SKU." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryAppSkuProperties" + } + ] + }, + "TestTypeListResult": { + "description": "A list of test types.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TestTypeResource" + }, + "description": "The list of test types." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "TestTypeResource": { + "description": "The test type resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestTypeProperties", + "x-ms-client-flatten": true, + "description": "Test Type properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "TestTypeProperties": { + "description": "The Test Type properties.", + "type": "object", + "properties": { + "actualTestTypeName": { + "type": "string", + "description": "The actual name of a test type of a Test Base Account." + } + } + }, + "PackageCheckNameAvailabilityParameters": { + "description": "Parameters body to pass for Test Base Package name availability check.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Resource name to verify." + }, + "applicationName": { + "type": "string", + "description": "Application name to verify." + }, + "version": { + "type": "string", + "description": "Version name to verify." + }, + "type": { + "type": "string", + "description": "fully qualified resource type which includes provider namespace." + } + }, + "required": [ + "name", + "applicationName", + "version" + ] + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Value indicating the availability of the name: true if the name is available; otherwise, false." + }, + "reason": { + "type": "string", + "description": "The reason for unavailability of a name. Required if nameAvailable == false.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "reason", + "modelAsString": true + } + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The detailed info regarding the reason associated with the name. Required if nameAvailable == false." + } + }, + "type": "object", + "description": "Description of a Check Name availability response properties." + }, + "PackageRunTestParameters": { + "description": "The parameters supplied to the Test Base Package to start a Test Run.", + "type": "object", + "properties": { + "testType": { + "$ref": "#/definitions/TestType", + "description": "The type of the test." + }, + "osUpdateType": { + "type": "string", + "description": "Specifies the OS update type to test against.", + "default": "SecurityUpdate", + "enum": [ + "SecurityUpdate", + "FeatureUpdate", + "InplaceUpgrade" + ], + "x-ms-enum": { + "name": "osUpdateType", + "modelAsString": true + } + }, + "osName": { + "type": "string", + "description": "The operating system name. e.g. Windows 10 1809." + }, + "releaseName": { + "type": "string", + "description": "The name of the tested release (OS update)." + }, + "flightingRing": { + "type": "string", + "description": "The flighting ring, only for release of feature updates." + }, + "customImageId": { + "type": "string", + "description": "The tested custom image id. 'osName', 'release', 'buildVersion' and 'mediaPackageVersion' would be ignored when it's eligible.'" + } + } + }, + "PackageListResult": { + "description": "A list of Test Base Packages.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PackageResource" + }, + "description": "The list of Test Base Packages." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "PackageResource": { + "description": "The Test Base Package resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PackageProperties", + "x-ms-client-flatten": true, + "description": "Test Base Package properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "PackageProperties": { + "description": "The properties of the Test Base Package.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "applicationName": { + "type": "string", + "description": "Application name" + }, + "version": { + "type": "string", + "description": "Application version" + }, + "draftPackageId": { + "type": "string", + "description": "The id of draft package. Used to create or update this package from a draft package." + }, + "packageStatus": { + "readOnly": true, + "type": "string", + "description": "The status of the package.", + "enum": [ + "Unknown", + "Registered", + "Ready", + "Error", + "ValidatingPackage", + "PreValidationCheckPass", + "Deleted", + "ValidationLongerThanUsual", + "VerifyingPackage" + ], + "x-ms-enum": { + "name": "packageStatus", + "modelAsString": true + } + }, + "isEnabled": { + "type": "boolean", + "readOnly": true, + "description": "Flag showing that whether the package is enabled. It doesn't schedule test for package which is not enabled." + }, + "blobPath": { + "type": "string", + "description": "The file path of the package." + }, + "validationResults": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PackageValidationResult" + }, + "x-ms-identifiers": [], + "description": "The validation results. There's validation on package when it's created or updated." + }, + "testTypes": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TestType" + }, + "description": "OOB, functional or flow driven. Mapped to the data in 'tests' property." + }, + "targetOSList": { + "type": "array", + "items": { + "$ref": "#/definitions/TargetOSInfo" + }, + "x-ms-identifiers": [], + "description": "Specifies the target OSs of specific OS Update types." + }, + "inplaceUpgradeOSPair": { + "$ref": "#/definitions/InplaceUpgradeOSInfo", + "description": "Specifies the baseline os and target os for inplace upgrade." + }, + "lastModifiedTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The UTC timestamp when the package was last modified." + }, + "flightingRing": { + "type": "string", + "description": "The flighting ring for feature update." + }, + "firstPartyApps": { + "description": "The list of first party applications to test along with user application.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/FirstPartyAppDefinition" + } + }, + "galleryApps": { + "description": "The list of gallery apps to test along with user application.", + "type": "array", + "items": { + "$ref": "#/definitions/GalleryAppDefinition" + }, + "x-ms-identifiers": [ + "skuId" + ], + "readOnly": true + }, + "tests": { + "type": "array", + "items": { + "$ref": "#/definitions/Test" + }, + "x-ms-identifiers": [], + "description": "The detailed test information." + }, + "intuneEnrollmentMetadata": { + "description": "The metadata of Intune enrollment.", + "$ref": "#/definitions/IntuneEnrollmentMetadata" + } + }, + "required": [ + "applicationName", + "version" + ] + }, + "TestType": { + "type": "string", + "description": "The test type.", + "enum": [ + "OutOfBoxTest", + "FunctionalTest", + "FlowDrivenTest" + ], + "x-ms-enum": { + "name": "testType", + "modelAsString": true + } + }, + "Architecture": { + "type": "string", + "description": "The architecture of an OS or a first party application.", + "enum": [ + "x86", + "x64", + "arm64" + ], + "x-ms-enum": { + "name": "architecture", + "modelAsString": true + } + }, + "TargetOSInfo": { + "description": "The information of the target OS to be tested.", + "type": "object", + "properties": { + "osUpdateType": { + "type": "string", + "description": "Specifies the OS update type to test against, e.g., 'Security updates' or 'Feature updates'." + }, + "targetOSs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the target OSs to be tested." + }, + "insiderChannelIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Insider Channel Ids. Only used for feature update." + }, + "baselineOSs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the baseline OSs to be tested." + }, + "targetOSImageIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the ids of the target OSs from Custom Images to be tested." + } + }, + "required": [ + "osUpdateType" + ] + }, + "PackageValidationResult": { + "description": "The validation results. There's validation on package when it's created or updated.", + "type": "object", + "properties": { + "validationName": { + "type": "string", + "readOnly": true, + "description": "Validation name." + }, + "isValid": { + "type": "boolean", + "readOnly": true, + "description": "Indicates whether the package passed the validation." + }, + "errors": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "Error information." + } + } + }, + "Test": { + "description": "The definition of a Test.", + "type": "object", + "properties": { + "testType": { + "$ref": "#/definitions/TestType", + "description": "The type of the test." + }, + "validationRunStatus": { + "readOnly": true, + "type": "string", + "description": "The status of the validation run of the package.", + "enum": [ + "Unknown", + "Pending", + "Passed", + "Failed" + ], + "x-ms-enum": { + "name": "validationRunStatus", + "modelAsString": true + } + }, + "validationResultId": { + "readOnly": true, + "type": "string", + "description": "Resource identifier of the validation test result." + }, + "isActive": { + "type": "boolean", + "description": "Indicates if this test is active.It doesn't schedule test for not active Test." + }, + "commands": { + "type": "array", + "items": { + "$ref": "#/definitions/Command" + }, + "x-ms-identifiers": [], + "description": "The commands used in the test." + } + }, + "required": [ + "testType", + "commands" + ] + }, + "Command": { + "description": "The command used in the test", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the command." + }, + "action": { + "type": "string", + "description": "The action of the command.", + "enum": [ + "Install", + "Launch", + "Close", + "Uninstall", + "Custom", + "FlowDrivenCustom" + ], + "x-ms-enum": { + "name": "action", + "modelAsString": true + } + }, + "contentType": { + "type": "string", + "description": "The type of command content.", + "enum": [ + "Inline", + "File", + "Path" + ], + "x-ms-enum": { + "name": "contentType", + "modelAsString": true + } + }, + "content": { + "type": "string", + "description": "The content of the command. The content depends on source type." + }, + "runElevated": { + "type": "boolean", + "description": "Specifies whether to run the command as administrator." + }, + "restartAfter": { + "type": "boolean", + "description": "Specifies whether to restart the VM after the command executed." + }, + "maxRunTime": { + "type": "integer", + "format": "int32", + "description": "Specifies the max run time of the command." + }, + "runAsInteractive": { + "type": "boolean", + "description": "Specifies whether to run the command in interactive mode." + }, + "alwaysRun": { + "type": "boolean", + "description": "Specifies whether to run the command even if a previous command is failed." + }, + "applyUpdateBefore": { + "type": "boolean", + "description": "Specifies whether to apply update before the command." + }, + "install1PAppBefore": { + "type": "boolean", + "description": "Specifies whether to install first party applications before running the command." + }, + "preUpgrade": { + "type": "boolean", + "description": "Specifies whether the command is assigned to be executed before in-place upgrade." + }, + "postUpgrade": { + "type": "boolean", + "description": "Specifies whether the command is assigned to be executed after in-place upgrade." + }, + "enrollIntuneBefore": { + "type": "boolean", + "description": "Specifies whether to enroll Intune before the command." + } + }, + "required": [ + "name", + "action", + "contentType", + "content" + ] + }, + "PackageUpdateParameters": { + "description": "Parameters supplied to update a Test Base Package.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PackageUpdateParameterProperties", + "x-ms-client-flatten": true, + "description": "Test Base Package update parameters." + }, + "tags": { + "description": "The tags of the Package.", + "$ref": "#/definitions/Tags" + } + } + }, + "PackageUpdateParameterProperties": { + "description": "Parameters supplied to update a Test Base Package.", + "type": "object", + "properties": { + "draftPackageId": { + "type": "string", + "description": "The id of draft package. Used to create or update this package from a draft package." + }, + "isEnabled": { + "type": "boolean", + "description": "Specifies whether the package is enabled. It doesn't schedule test for package which is not enabled." + }, + "blobPath": { + "type": "string", + "description": "The file name of the package." + }, + "targetOSList": { + "type": "array", + "items": { + "$ref": "#/definitions/TargetOSInfo" + }, + "x-ms-identifiers": [], + "description": "Specifies the target OSs of specific OS Update types." + }, + "inplaceUpgradeOSPair": { + "$ref": "#/definitions/InplaceUpgradeOSInfo", + "description": "Specifies the baseline os and target os for in-place upgrade." + }, + "flightingRing": { + "type": "string", + "description": "The flighting ring for feature update." + }, + "firstPartyApps": { + "description": "Specifies the list of first party applications to test along with user application.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/FirstPartyAppDefinition" + } + }, + "tests": { + "type": "array", + "items": { + "$ref": "#/definitions/Test" + }, + "x-ms-identifiers": [], + "description": "The detailed test information." + }, + "intuneEnrollmentMetadata": { + "description": "The metadata of Intune enrollment.", + "$ref": "#/definitions/IntuneEnrollmentMetadata" + } + } + }, + "TestResultConsoleLogDownloadURLParameters": { + "description": "Parameters body to pass for getting the download URL of the test execution console log file.", + "type": "object", + "properties": { + "logFileName": { + "type": "string", + "description": "The log file name corresponding to the download URL." + } + }, + "required": [ + "logFileName" + ] + }, + "DownloadURLResponse": { + "description": "The response of getting a download URL.", + "type": "object", + "properties": { + "downloadUrl": { + "type": "string", + "readOnly": true, + "x-ms-secret": true, + "description": "The download URL." + }, + "expirationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Expiry date of the download URL." + } + } + }, + "TestSummaryListResult": { + "description": "A list of Test Summaries.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TestSummaryResource" + }, + "description": "The list of Test Summaries." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "TestSummaryResource": { + "description": "Summary of a Test.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TestSummaryProperties", + "description": "Properties of a Test Summary." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "TestSummaryProperties": { + "description": "Properties of a Test Summary.", + "type": "object", + "properties": { + "testSummaryId": { + "type": "string", + "description": "The Id of the current Test Summary." + }, + "packageId": { + "type": "string", + "description": "The Azure resource Id of package." + }, + "applicationName": { + "type": "string", + "description": "Application name." + }, + "applicationVersion": { + "type": "string", + "description": "Application version." + }, + "executionStatus": { + "$ref": "#/definitions/TestExecutionStatus", + "description": "The execution status of last test." + }, + "testStatus": { + "$ref": "#/definitions/TestStatus", + "description": "The status of last test." + }, + "grade": { + "$ref": "#/definitions/TestGrade", + "description": "The grade of the test." + }, + "testRunTime": { + "type": "string", + "description": "The run time of the last test." + }, + "featureUpdatesTestSummary": { + "$ref": "#/definitions/OSUpdatesTestSummary", + "description": "The result summary of tests triggered by feature updates" + }, + "securityUpdatesTestSummary": { + "$ref": "#/definitions/OSUpdatesTestSummary", + "description": "The result summary of tests triggered by security updates" + }, + "inplaceUpgradesTestSummary": { + "$ref": "#/definitions/OSUpdatesTestSummary", + "description": "The result summary of tests triggered by in-place upgrades" + }, + "packageTags": { + "description": "The tags of Package resource that are associated with the testSummary", + "$ref": "#/definitions/Tags" + } + } + }, + "TestExecutionStatus": { + "type": "string", + "description": "The execution status of a test.", + "enum": [ + "None", + "InProgress", + "Processing", + "Completed", + "NotExecuted", + "Incomplete", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "executionStatus", + "modelAsString": true + } + }, + "TestStatus": { + "type": "string", + "description": "The status of a test.", + "enum": [ + "None", + "TestExecutionInProgress", + "DataProcessing", + "TestFailure", + "UpdateFailure", + "TestAndUpdateFailure", + "InfrastructureFailure", + "Completed" + ], + "x-ms-enum": { + "name": "testStatus", + "modelAsString": true + } + }, + "TestGrade": { + "type": "string", + "description": "The grade of a test.", + "enum": [ + "None", + "NotAvailable", + "Pass", + "Fail" + ], + "x-ms-enum": { + "name": "grade", + "modelAsString": true + } + }, + "OSUpdatesTestSummary": { + "description": "The summary of some tests.", + "type": "object", + "properties": { + "executionStatus": { + "$ref": "#/definitions/TestExecutionStatus", + "description": "The status of the last test." + }, + "testStatus": { + "$ref": "#/definitions/TestStatus", + "description": "The status of last test." + }, + "grade": { + "$ref": "#/definitions/TestGrade", + "description": "The grade of last test." + }, + "testRunTime": { + "type": "string", + "description": "The run time of the last test." + }, + "osUpdateTestSummaries": { + "type": "array", + "items": { + "$ref": "#/definitions/OSUpdateTestSummary" + }, + "x-ms-identifiers": [], + "description": "Detailed summary for each OS update" + } + } + }, + "OSUpdateTestSummary": { + "description": "The summary of a test.", + "type": "object", + "properties": { + "osName": { + "type": "string", + "description": "The operating system name. e.g. Windows 10 1809." + }, + "customImageId": { + "type": "string", + "description": "Specify the referenced Test Base Custom Image Id if available." + }, + "customImageDisplayName": { + "type": "string", + "description": "The name of the custom image resource." + }, + "releaseName": { + "type": "string", + "description": "The name of the tested release (OS update)." + }, + "buildVersion": { + "type": "string", + "description": "The build version of the tested release (OS update)" + }, + "buildRevision": { + "type": "string", + "description": "The build revision of the tested release (OS update)" + }, + "releaseVersionDate": { + "type": "string", + "format": "date-time", + "description": "The release version date." + }, + "flightingRing": { + "type": "string", + "description": "The flighting ring, only for release of feature updates." + }, + "executionStatus": { + "$ref": "#/definitions/TestExecutionStatus", + "description": "The execution status of the test." + }, + "testStatus": { + "$ref": "#/definitions/TestStatus", + "description": "The status of the test." + }, + "grade": { + "$ref": "#/definitions/TestGrade", + "description": "The grade of the test." + }, + "testRunTime": { + "type": "string", + "description": "The run time of the test." + }, + "testType": { + "type": "string", + "description": "The test type of the package" + }, + "inplaceUpgradeBaselineProperties": { + "$ref": "#/definitions/OsProperties", + "description": "The properties of baseline os for in-place upgrade test." + } + } + }, + "TestResultListResult": { + "description": "A list of Test Results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TestResultResource" + }, + "description": "The list of Test Results." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "TestResultResource": { + "description": "The Test Result Resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestResultProperties", + "x-ms-client-flatten": true, + "description": "The properties of a Test Result." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "TestResultProperties": { + "description": "The properties of a Test Result.", + "type": "object", + "properties": { + "baselineTestResultId": { + "type": "string", + "description": "Azure Id of the baseline test result." + }, + "packageId": { + "type": "string", + "description": "Resource Id of the package." + }, + "applicationName": { + "type": "string", + "description": "Application name." + }, + "applicationVersion": { + "type": "string", + "description": "Application version." + }, + "osName": { + "type": "string", + "description": "The operating system name, e.g. Windows 10 1809." + }, + "customImageId": { + "type": "string", + "description": "Specify the referenced Test Base Custom Image Id if applicable." + }, + "customImageDisplayName": { + "type": "string", + "description": "The name of the custom image resource." + }, + "releaseName": { + "type": "string", + "description": "The name of the tested release (OS update)." + }, + "releaseVersionDate": { + "type": "string", + "format": "date-time", + "description": "The release version date of the tested release." + }, + "flightingRing": { + "type": "string", + "description": "The flighting ring, only for release of feature updates." + }, + "buildVersion": { + "type": "string", + "description": "The build version of the tested release (OS update)." + }, + "buildRevision": { + "type": "string", + "description": "The build revision of the tested release (OS update)." + }, + "testType": { + "type": "string", + "description": "Test type. E.g. 'Out of box test' or 'Functional test'." + }, + "testRunTime": { + "type": "string", + "description": "The run time of the test." + }, + "isDownloadDataAvailable": { + "type": "boolean", + "description": "Whether download data is available." + }, + "isVideoAvailable": { + "type": "boolean", + "description": "Whether video data is available." + }, + "executionStatus": { + "$ref": "#/definitions/TestExecutionStatus", + "description": "The execution status of the test." + }, + "testStatus": { + "$ref": "#/definitions/TestStatus", + "description": "The status of the test." + }, + "grade": { + "$ref": "#/definitions/TestGrade", + "description": "The grade of the test." + }, + "kbNumber": { + "type": "string", + "description": "KB number." + }, + "interopMediaType": { + "type": "string", + "description": "Interop media type." + }, + "interopMediaVersion": { + "type": "string", + "description": "Interop media version." + }, + "packageVersion": { + "type": "string", + "description": "The version of the Windows update package." + }, + "analysisSummaries": { + "type": "array", + "items": { + "$ref": "#/definitions/TestResultAnalysisSummary" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of analysis summaries." + }, + "inplaceUpgradeProperties": { + "$ref": "#/definitions/InplaceUpgradeProperties", + "description": "Properties for inplace upgrade test." + }, + "testStartTime": { + "type": "string", + "format": "date-time", + "description": "The time when test starts." + }, + "testEndTime": { + "type": "string", + "format": "date-time", + "description": "The time when test ends." + }, + "firstPartyApps": { + "type": "array", + "items": { + "$ref": "#/definitions/TestResultFirstPartyAppDefinition" + }, + "x-ms-identifiers": [], + "description": "The list of first party applications tested along with the package." + } + } + }, + "TestResultAnalysisSummary": { + "description": "The summary of a Test Analysis Result.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Metric name" + }, + "analysisStatus": { + "type": "string", + "description": "The analysis status.", + "enum": [ + "None", + "Completed", + "InProgress", + "Failed", + "Succeeded", + "Available", + "NotAvailable" + ], + "x-ms-enum": { + "name": "analysisStatus", + "modelAsString": true + } + }, + "grade": { + "$ref": "#/definitions/TestGrade", + "description": "The grade of the test result." + } + } + }, + "OSUpdateListResult": { + "description": "A list of OS Updates.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OSUpdateResource" + }, + "description": "The list of OS Updates." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "OSUpdateResource": { + "description": "An OS Update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OSUpdateProperties", + "description": "Properties of an OS Update." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "OSUpdateProperties": { + "description": "Properties of an OS Update.", + "type": "object", + "properties": { + "osName": { + "type": "string", + "description": "The name of the OS." + }, + "release": { + "type": "string", + "description": "The name of tested release." + }, + "flightingRing": { + "type": "string", + "description": "The flighting ring, only for release of feature updates." + }, + "buildVersion": { + "type": "string", + "description": "The build version of the tested release (OS update)." + }, + "buildRevision": { + "type": "string", + "description": "The build revision of the tested release (OS update)" + }, + "type": { + "type": "string", + "description": "The type of this release (OS update).", + "enum": [ + "SecurityUpdate", + "FeatureUpdate", + "InplaceUpgrade" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true + } + }, + "releaseVersionDate": { + "type": "string", + "format": "date-time", + "description": "The release version date the tested release (OS update)" + }, + "inplaceUpgradeBaselineProperties": { + "$ref": "#/definitions/OsProperties", + "description": "The properties of baseline os for in-place upgrade test." + }, + "customImageId": { + "type": "string", + "description": "Specify the referenced Test Base Custom Image Id if available." + }, + "customImageDisplayName": { + "type": "string", + "description": "The name of the custom image resource." + } + } + }, + "FavoriteProcessListResult": { + "description": "A list of favorite processes for a package.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FavoriteProcessResource" + }, + "description": "The list of favorite processes for a package." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "FavoriteProcessResource": { + "description": "A favorite process identifier.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FavoriteProcessProperties", + "description": "Properties of a favorite process identifier." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "FavoriteProcessProperties": { + "description": "Properties of a favorite process identifier.", + "type": "object", + "properties": { + "actualProcessName": { + "type": "string", + "description": "The actual name of the favorite process. It will be equal to resource name except for the scenario that the process name contains characters that are not allowed in the resource name." + } + }, + "required": [ + "actualProcessName" + ] + }, + "AnalysisResultListResult": { + "description": "A list of Analysis Results. It will only contain one element as all the data will be nested in a singleton object.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalysisResultSingletonResource" + }, + "description": "The list of Analysis Results." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "AnalysisResultSingletonResource": { + "description": "The Analysis Result Singleton Resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AnalysisResultSingletonResourceProperties", + "description": "Properties of an Analysis Result." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AnalysisResultSingletonResourceProperties": { + "description": "The properties of Analysis Result resource.", + "type": "object", + "discriminator": "analysisResultType", + "required": [ + "analysisResultType" + ], + "properties": { + "grade": { + "$ref": "#/definitions/TestGrade", + "description": "The grade of the test." + }, + "analysisResultType": { + "description": "Type of the Analysis Result.", + "enum": [ + "ScriptExecution", + "Reliability", + "CPUUtilization", + "MemoryUtilization", + "CPURegression", + "MemoryRegression", + "TestAnalysis" + ], + "type": "string", + "x-ms-enum": { + "name": "analysisResultType", + "modelAsString": true + } + } + } + }, + "ScriptExecutionResultSingletonResourceProperties": { + "description": "The properties of Script Execution Result.", + "type": "object", + "x-ms-discriminator-value": "ScriptExecution", + "properties": { + "scriptExecutionResults": { + "description": "The result array data.", + "type": "array", + "items": { + "$ref": "#/definitions/ScriptExecutionResult" + }, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisResultSingletonResourceProperties" + } + ] + }, + "ScriptExecutionResult": { + "description": "The Script Execution Result.", + "type": "object", + "properties": { + "scriptName": { + "type": "string", + "description": "Name of script." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of script execution." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of script execution." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "description": "Exit code." + }, + "timedOut": { + "type": "boolean", + "description": "Whether the script execution is timed out." + }, + "stdoutLogFileName": { + "type": "string", + "description": "The stdout log file name." + }, + "stderrLogFileName": { + "type": "string", + "description": "The stderr log file name." + } + } + }, + "ReliabilityResultSingletonResourceProperties": { + "description": "The properties of Reliability Result.", + "type": "object", + "x-ms-discriminator-value": "Reliability", + "properties": { + "reliabilityResults": { + "description": "The result array data.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ReliabilityResult" + } + }, + "inplaceUpgradeBaselineReliabilityResults": { + "description": "The result array data for target os in an in-place upgrade test.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ReliabilityResult" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisResultSingletonResourceProperties" + } + ] + }, + "ReliabilityResult": { + "description": "The Reliability Result.", + "type": "object", + "properties": { + "fileName": { + "type": "string", + "description": "File name." + }, + "launchCount": { + "type": "integer", + "format": "int32", + "description": "Count of number of launches." + }, + "crashCount": { + "type": "integer", + "format": "int32", + "description": "Count of number of crashes." + }, + "hangCount": { + "type": "integer", + "format": "int32", + "description": "Count of number of hangs." + }, + "regressionGrade": { + "$ref": "#/definitions/TestGrade", + "description": "The regression grade." + }, + "crashRegressionGrade": { + "$ref": "#/definitions/TestGrade", + "description": "The statistic regression grade for crash signal." + }, + "crashRegressionTestDetails": { + "$ref": "#/definitions/RegressionTestDetails", + "description": "Details related to the crash regression analysis." + }, + "hangRegressionGrade": { + "$ref": "#/definitions/TestGrade", + "description": "The statistic regression grade for hang signal." + }, + "hangRegressionTestDetails": { + "$ref": "#/definitions/RegressionTestDetails", + "description": "Details related to the hang regression analysis." + } + } + }, + "RegressionTestDetails": { + "description": "The details of a regression test.", + "type": "object", + "properties": { + "diff": { + "type": "number", + "format": "double", + "description": "Difference between the two datasets being analyzed." + }, + "isRegressed": { + "type": "boolean", + "description": "Indicates if a regression was inferred." + } + } + }, + "CPUUtilizationResultSingletonResourceProperties": { + "description": "The properties of CPU Utilization Result.", + "type": "object", + "x-ms-discriminator-value": "CPUUtilization", + "properties": { + "cpuUtilizationResults": { + "description": "The result array data.", + "type": "array", + "items": { + "$ref": "#/definitions/UtilizationResult" + }, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisResultSingletonResourceProperties" + } + ] + }, + "MemoryUtilizationResultSingletonResourceProperties": { + "description": "The properties of Memory Utilization Result.", + "type": "object", + "x-ms-discriminator-value": "MemoryUtilization", + "properties": { + "memoryUtilizationResults": { + "description": "The result array data.", + "type": "array", + "items": { + "$ref": "#/definitions/UtilizationResult" + }, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisResultSingletonResourceProperties" + } + ] + }, + "UtilizationResult": { + "description": "The Utilization Result.", + "type": "object", + "properties": { + "process": { + "type": "string", + "description": "Process name, or '_total' for all processes" + }, + "upperBound": { + "$ref": "#/definitions/UtilizationBound", + "description": "Upper bound" + }, + "lowerBound": { + "$ref": "#/definitions/UtilizationBound", + "description": "Lower bound" + }, + "utilization": { + "type": "array", + "items": { + "$ref": "#/definitions/UtilizationEntry" + }, + "x-ms-identifiers": [], + "description": "Utilization data" + } + } + }, + "UtilizationBound": { + "description": "The bound of a utilization result.", + "type": "object", + "properties": { + "percentile": { + "type": "number", + "format": "double", + "description": "The percentile of the bound." + }, + "value": { + "type": "number", + "format": "double", + "description": "The value of the bound." + } + } + }, + "UtilizationEntry": { + "description": "The utilization entry.", + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The timestamp." + }, + "value": { + "type": "number", + "format": "double", + "description": "The value." + } + } + }, + "CPURegressionResultSingletonResourceProperties": { + "description": "The properties of CPU Regression Result.", + "type": "object", + "x-ms-discriminator-value": "CPURegression", + "properties": { + "cpuRegressionResults": { + "description": "The result array data.", + "type": "array", + "items": { + "$ref": "#/definitions/RegressionResult" + }, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisResultSingletonResourceProperties" + } + ] + }, + "MemoryRegressionResultSingletonResourceProperties": { + "description": "The properties of Memory Regression Result.", + "type": "object", + "x-ms-discriminator-value": "MemoryRegression", + "properties": { + "memoryRegressionResults": { + "description": "The result array data.", + "type": "array", + "items": { + "$ref": "#/definitions/RegressionResult" + }, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisResultSingletonResourceProperties" + } + ] + }, + "RegressionResult": { + "description": "The regression result.", + "type": "object", + "properties": { + "fileName": { + "type": "string", + "description": "FileName of the binary being analyzed." + }, + "grade": { + "$ref": "#/definitions/TestGrade", + "description": "The grade of the test." + }, + "details": { + "type": "string", + "description": "Message that facilitates debugging a particular regression, if any was inferred." + }, + "diff": { + "type": "number", + "format": "double", + "description": "Difference between the two datasets being analyzed." + }, + "isRegressed": { + "type": "boolean", + "description": "Indicates if a regression was inferred." + } + } + }, + "TestAnalysisResultSingletonResourceProperties": { + "description": "The properties of Test Analysis Result.", + "type": "object", + "x-ms-discriminator-value": "TestAnalysis", + "properties": { + "testAnalysisResult": { + "$ref": "#/definitions/TestAnalysisResult", + "description": "The result of test analysis." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisResultSingletonResourceProperties" + } + ] + }, + "TestAnalysisResult": { + "description": "The test analysis result.", + "type": "object", + "properties": { + "blobData": { + "type": "string", + "description": "The data to provide more failure analysis information." + }, + "testAnalysisStatus": { + "type": "string", + "description": "The status of the analysis.", + "enum": [ + "None", + "Analyzing", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "testAnalysisStatus", + "modelAsString": true + } + }, + "identifiedFailures": { + "description": "The array of identified failures.", + "type": "array", + "items": { + "$ref": "#/definitions/IdentifiedFailure" + }, + "x-ms-identifiers": [ + "failureId" + ] + } + } + }, + "IdentifiedFailure": { + "description": "The failure identified.", + "type": "object", + "properties": { + "failureId": { + "type": "string", + "description": "The Failure Id." + }, + "category": { + "type": "string", + "description": "The category of the failure.", + "enum": [ + "None", + "Unidentified", + "Package", + "OSUpdate", + "Infrastructure" + ], + "x-ms-enum": { + "name": "category", + "modelAsString": true + } + }, + "errorMessage": { + "type": "string", + "description": "Message that shows information about the failure." + }, + "guidance": { + "type": "string", + "description": "Guidance that shows what the customer needs to do for this failure." + } + } + }, + "EmailEventListResult": { + "description": "A list of email events.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EmailEventResource" + }, + "description": "The list of email events." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "EmailEventResource": { + "description": "The email event resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EmailEventProperties", + "x-ms-client-flatten": true, + "description": "Email Event properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EmailEventProperties": { + "description": "The Email Event properties.", + "type": "object", + "properties": { + "eventId": { + "type": "string", + "description": "The identifier of the email event." + }, + "eventName": { + "type": "string", + "description": "The name of the email event." + }, + "displayName": { + "type": "string", + "description": "The display name of the email event." + } + } + }, + "CustomerEventListResult": { + "description": "A list of Test Base Customer Events.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomerEventResource" + }, + "description": "The list of Test Base Customer Events." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "CustomerEventResource": { + "description": "The Customer Notification Event resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CustomerEventProperties", + "x-ms-client-flatten": true, + "description": "Customer Notification Event properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "CustomerEventProperties": { + "description": "A notification events subscribed to be received by customer.", + "type": "object", + "properties": { + "eventName": { + "type": "string", + "description": "The name of the event subscribed to." + }, + "receivers": { + "type": "array", + "items": { + "$ref": "#/definitions/NotificationEventReceiver" + }, + "x-ms-identifiers": [], + "description": "The notification event receivers." + } + }, + "required": [ + "eventName", + "receivers" + ] + }, + "NotificationEventReceiver": { + "description": "A notification event receivers.", + "type": "object", + "properties": { + "receiverType": { + "type": "string", + "description": "The type of the notification event receiver." + }, + "receiverValue": { + "description": "The notification event receiver value.", + "$ref": "#/definitions/NotificationReceiverValue" + } + } + }, + "NotificationReceiverValue": { + "description": "A notification event receiver value.", + "type": "object", + "properties": { + "userObjectReceiverValue": { + "description": "The user object receiver value.", + "$ref": "#/definitions/UserObjectReceiverValue" + }, + "subscriptionReceiverValue": { + "description": "The user object receiver value.", + "$ref": "#/definitions/SubscriptionReceiverValue" + }, + "distributionGroupListReceiverValue": { + "description": "The user object receiver value.", + "$ref": "#/definitions/DistributionGroupListReceiverValue" + } + } + }, + "UserObjectReceiverValue": { + "description": "The user object receiver value.", + "type": "object", + "properties": { + "userObjectIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "user object ids." + } + } + }, + "SubscriptionReceiverValue": { + "description": "The subscription role receiver value.", + "type": "object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "The subscription id of the notification receiver." + }, + "subscriptionName": { + "type": "string", + "description": "The subscription name of the notification receiver." + }, + "role": { + "type": "string", + "description": "The role of the notification receiver." + } + } + }, + "DistributionGroupListReceiverValue": { + "description": "The user object receiver value.", + "type": "object", + "properties": { + "distributionGroups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of distribution groups." + } + } + }, + "BillingHubExecutionUsageDetail": { + "type": "object", + "properties": { + "applicationName": { + "type": "string" + }, + "applicationVersion": { + "type": "string" + }, + "executionRequestId": { + "type": "string" + }, + "sku": { + "type": "string" + }, + "meterId": { + "type": "string" + }, + "startTimeStamp": { + "type": "string", + "format": "date-time" + }, + "endTimeStamp": { + "type": "string", + "format": "date-time" + }, + "osBuild": { + "type": "string" + }, + "release": { + "type": "string" + }, + "testType": { + "type": "string" + }, + "updateType": { + "type": "string" + }, + "usedFreeHours": { + "type": "number", + "format": "double" + }, + "usedBillableHours": { + "type": "number", + "format": "double" + }, + "billedCharges": { + "type": "number", + "format": "double" + } + } + }, + "BillingHubGetFreeHourBalanceResponse": { + "type": "object", + "properties": { + "totalRemainingFreeHours": { + "type": "number", + "format": "double" + }, + "incrementEntries": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/BillingHubFreeHourIncrementEntry" + } + } + } + }, + "BillingHubFreeHourIncrementEntry": { + "type": "object", + "properties": { + "freeHourType": { + "type": "string", + "enum": [ + "Permanent", + "Temporary" + ], + "x-ms-enum": { + "name": "freeHourType", + "modelAsString": true + } + }, + "freeHourStatus": { + "type": "string", + "enum": [ + "Enabled", + "Suspended" + ], + "x-ms-enum": { + "name": "freeHourStatus", + "modelAsString": true + } + }, + "createTimeStamp": { + "type": "string", + "format": "date-time" + }, + "expirationTimeStamp": { + "type": "string", + "format": "date-time" + }, + "incrementalFreeHours": { + "type": "number", + "format": "double" + }, + "remainingFreeHours": { + "type": "number", + "format": "double" + } + } + }, + "BillingHubGetUsageResponse": { + "type": "object", + "properties": { + "totalUsedFreeHours": { + "type": "number", + "format": "double" + }, + "totalUsedBillableHours": { + "type": "number", + "format": "double" + }, + "totalCharges": { + "type": "number", + "format": "double" + }, + "packageUsageEntries": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/BillingHubPackageUsage" + } + }, + "nextRequest": { + "type": "object", + "$ref": "#/definitions/BillingHubGetUsageRequest" + } + } + }, + "BillingHubPackageUsage": { + "type": "object", + "properties": { + "applicationName": { + "type": "string" + }, + "applicationVersion": { + "type": "string" + }, + "azureResourceUri": { + "type": "string" + }, + "totalUsedFreeHours": { + "type": "number", + "format": "double" + }, + "totalUsedBillableHours": { + "type": "number", + "format": "double" + }, + "totalCharges": { + "type": "number", + "format": "double" + }, + "usageEntriesGroupedByUpdateType": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/BillingHubUsageGroupedByUpdateType" + } + } + } + }, + "BillingHubUsageGroupedByUpdateType": { + "type": "object", + "properties": { + "updateType": { + "type": "string" + }, + "totalUsedFreeHours": { + "type": "number", + "format": "double" + }, + "totalUsedBillableHours": { + "type": "number", + "format": "double" + }, + "totalCharges": { + "type": "number", + "format": "double" + }, + "usageGroups": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/BillingHubUsageGroup" + } + } + } + }, + "BillingHubUsage": { + "type": "object", + "properties": { + "applicationName": { + "type": "string" + }, + "applicationVersion": { + "type": "string" + }, + "azureResourceUri": { + "type": "string" + }, + "totalUsedFreeHours": { + "type": "number", + "format": "double" + }, + "totalUsedBillableHours": { + "type": "number", + "format": "double" + }, + "totalCharges": { + "type": "number", + "format": "double" + }, + "usageGroups": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/BillingHubUsageGroup" + } + } + } + }, + "BillingHubUsageGroup": { + "type": "object", + "properties": { + "totalUsedFreeHours": { + "type": "number", + "format": "double" + }, + "totalUsedBillableHours": { + "type": "number", + "format": "double" + }, + "totalCharges": { + "type": "number", + "format": "double" + }, + "releaseBuildRevision": { + "type": "integer", + "format": "int64" + }, + "releaseBuildNumber": { + "type": "integer", + "format": "int64" + }, + "releaseBuildDate": { + "type": "string", + "format": "date-time" + }, + "osBuild": { + "type": "string" + }, + "release": { + "type": "string" + }, + "testType": { + "type": "string" + }, + "productFamily": { + "type": "string" + }, + "executionUsageDetails": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/BillingHubExecutionUsageDetail" + } + } + } + }, + "BillingHubGetUsageRequest": { + "type": "object", + "properties": { + "startTimeStamp": { + "type": "string", + "format": "date-time" + }, + "endTimeStamp": { + "type": "string", + "format": "date-time" + }, + "pageSize": { + "type": "integer", + "format": "int32" + }, + "pageIndex": { + "type": "integer", + "format": "int32" + } + }, + "required": [ + "startTimeStamp", + "endTimeStamp" + ] + }, + "AvailableInplaceUpgradeOSListResult": { + "description": "A list of available In-place Upgrade OSs.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableInplaceUpgradeOSResource" + }, + "description": "The list of available In-place Upgrade OS." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "AvailableInplaceUpgradeOSResource": { + "description": "The Available In-place Upgrade OS Map resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AvailableInplaceUpgradeOSProperties", + "x-ms-client-flatten": true, + "description": "Available In-place Upgrade OS Map properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AvailableInplaceUpgradeOSProperties": { + "description": "The Available In-place Upgrade OS properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "sourceOsName": { + "type": "string", + "description": "The name of an Available In-place Upgrade source OS of a Test Base Account." + }, + "sourceOsReleases": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ReleaseProperties" + }, + "description": "The the release list of the source os." + }, + "supportedTargetOsNameList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of the corresponding Available In-place Upgrade target OS name of a Test Base Account." + } + } + }, + "InplaceUpgradeOSInfo": { + "description": "Specifies the baseline os and target os for in-place upgrade tests.", + "type": "object", + "properties": { + "baselineOS": { + "$ref": "#/definitions/OsProperties", + "description": "Specifies the baseline os for in-place upgrade tests." + }, + "targetOS": { + "type": "string", + "description": "Specifies the target os for in-place upgrade tests." + } + } + }, + "OsProperties": { + "type": "object", + "properties": { + "osName": { + "type": "string", + "description": "The name of the OS." + }, + "customImageId": { + "type": "string", + "description": "Specify the referenced Test Base Custom Image Id if available." + }, + "customImageDisplayName": { + "type": "string", + "description": "The name of the custom image resource.", + "readOnly": true + }, + "releaseProperties": { + "$ref": "#/definitions/ReleaseProperties", + "description": "The properties of the OS release." + } + }, + "description": "The properties of an operating system." + }, + "ReleaseProperties": { + "type": "object", + "properties": { + "releaseName": { + "type": "string", + "description": "The name of the OS release." + }, + "buildNumber": { + "type": "string", + "description": "The build number of the OS release." + }, + "buildRevision": { + "type": "string", + "description": "The build revision of the OS release." + }, + "releaseVersionDate": { + "type": "string", + "format": "date-time", + "description": "The release version date of the OS release." + } + }, + "description": "The properties of an operating system release." + }, + "InplaceUpgradeProperties": { + "type": "object", + "properties": { + "upgradeStartTime": { + "type": "string", + "format": "date-time", + "description": "Time stamp for os upgrading start (UTC)." + }, + "upgradeEndTime": { + "type": "string", + "format": "date-time", + "description": "Time stamp for os upgrading end (UTC)." + }, + "customImageId": { + "type": "string", + "description": "Specify the referenced Test Base Custom Image Id if applicable." + }, + "customImageDisplayName": { + "type": "string", + "description": "The name of the custom image resource." + }, + "baselineOsName": { + "type": "string", + "description": "The name of the OS." + }, + "baselineReleaseName": { + "type": "string", + "description": "The name of the baseline OS release." + }, + "baselineBuildNumber": { + "type": "string", + "description": "The build number of the baseline OS release." + }, + "baselineBuildRevision": { + "type": "string", + "description": "The build revision of the baseline OS release." + }, + "baselineKbNumber": { + "type": "string", + "description": "The kb number of the baseline OS release." + }, + "baselineReleaseVersionDate": { + "type": "string", + "format": "date-time", + "description": "The release version date of the baseline OS release." + } + }, + "description": "Properties for in-place upgrade test result." + }, + "FreeHourBalancesListResult": { + "description": "A list of Test Base Free Hour Balances. It will only contain one element as all the data will be nested in a singleton object.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FreeHourBalanceResource" + }, + "description": "The list of FreeHourBalances." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if value contains incomplete list of results." + } + } + }, + "FreeHourBalanceResource": { + "description": "The Free Hour Balance Resource.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingHubGetFreeHourBalanceResponse", + "description": "Properties of a Free Hour Balance." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IntuneEnrollmentMetadata": { + "description": "The metadata of Intune enrollment.", + "type": "object", + "properties": { + "appList": { + "type": "array", + "items": { + "$ref": "#/definitions/EnrolledIntuneApp" + }, + "x-ms-identifiers": [], + "description": "The enrolled Intune apps." + }, + "credentialId": { + "description": "The id of the Intune enrollment credential.", + "type": "string" + }, + "expectedDeploymentDurationInMinute": { + "description": "The expected duration of Intune applications and policies deployment.", + "type": "integer", + "format": "int32" + } + } + }, + "EnrolledIntuneApp": { + "description": "Metadata of the enrolled Intune app.", + "type": "object", + "properties": { + "appName": { + "type": "string", + "description": "Intune app name." + }, + "appId": { + "type": "string", + "description": "Intune app id." + }, + "expectedInstallationPath": { + "type": "string", + "description": "Intune app expected installation path." + } + }, + "required": [ + "appName", + "appId", + "expectedInstallationPath" + ] + } + }, + "parameters": { + "TestBaseAccountNameParameter": { + "name": "testBaseAccountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of the Test Base Account.", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9_]|([-. ][A-Za-z0-9]))+$" + }, + "PackageNameParameter": { + "name": "packageName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of the Test Base Package.", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9_]|([-. ][A-Za-z0-9]))+$" + }, + "FavoriteProcessResourceNameParameter": { + "name": "favoriteProcessResourceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of a favorite process in a package. If the process name contains characters that are not allowed in Azure Resource Name, we use 'actualProcessName' in request body to submit the name." + }, + "TestResultNameParameter": { + "name": "testResultName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The Test Result Name. It equals to TestResult-{TestResultId} string." + }, + "OSUpdateTypeParameter": { + "name": "osUpdateType", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "SecurityUpdate", + "FeatureUpdate", + "InplaceUpgrade" + ], + "x-ms-enum": { + "name": "osUpdateType", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "The type of the OS Update." + }, + "AnalysisResultTypeParameter": { + "name": "analysisResultType", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "ScriptExecution", + "Reliability", + "MemoryUtilization", + "CPUUtilization", + "MemoryRegression", + "CPURegression", + "TestAnalysis" + ], + "x-ms-enum": { + "name": "analysisResultType", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "The type of the Analysis Result of a Test Result." + }, + "AnalysisResultNameParameter": { + "name": "analysisResultName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "scriptExecution", + "reliability", + "memoryUtilization", + "cpuUtilization", + "memoryRegression", + "cpuRegression", + "testAnalysis" + ], + "x-ms-enum": { + "name": "analysisResultName", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "The name of the Analysis Result of a Test Result." + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "type": "string", + "x-ms-parameter-location": "method", + "description": "Odata filter" + }, + "TestBaseAccountIncludeSoftDeletedParameter": { + "name": "getDeleted", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "The flag indicating if we need to include the Test Base Accounts which were soft deleted before." + }, + "TestBaseAccountRestoreSoftDeletedParameter": { + "name": "restore", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "The flag indicating if we would like to restore the Test Base Accounts which were soft deleted before." + }, + "CustomerEventNameParameter": { + "name": "customerEventName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of the Test Base Customer event." + }, + "AvailableInplaceUpgradeOSResouceNameParamaeter": { + "name": "availableInplaceUpgradeOSResourceNameParameter", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The available In-place Upgrade OS resource name." + }, + "GalleryAppNameParameter": { + "name": "galleryAppName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The resource name of a gallery application.", + "pattern": "^[A-Za-z0-9]([A-Za-z0-9]|(-[A-Za-z0-9]))+$" + }, + "KeywordParameter": { + "name": "keyword", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The keywords which listed results should be related to." + }, + "TopFilter": { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method", + "description": "How many of the sorted items to consider including in the result set." + }, + "FreeHourBalanceNameParameter": { + "name": "freeHourBalanceName", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "TenantLevel", + "SubscriptionLevel" + ], + "x-ms-enum": { + "name": "freeHourBalanceName", + "modelAsString": true + }, + "x-ms-parameter-location": "method", + "description": "The name of the free hour balance of a Test Base Account.", + "pattern": "^[A-Za-z]+$" + } + } +} diff --git a/specification/testbase/resource-manager/readme.azureresourceschema.md b/specification/testbase/resource-manager/readme.azureresourceschema.md new file mode 100644 index 000000000000..c86ff1ac325d --- /dev/null +++ b/specification/testbase/resource-manager/readme.azureresourceschema.md @@ -0,0 +1,46 @@ +## AzureResourceSchema + +These settings apply only when `--azureresourceschema` is specified on the command line. + +### AzureResourceSchema multi-api + +``` yaml $(azureresourceschema) && $(multiapi) +batch: + - tag: schema-testbase-2020-12-16-preview + - tag: schema-testbase-2022-04-01-preview + - tag: schema-testbase-2023-11-01-preview +``` + +Please also specify `--azureresourceschema-folder=`. + +### Tag: schema-testbase-2020-12-16-preview and azureresourceschema + +``` yaml $(tag) == 'schema-testbase-2020-12-16-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.TestBase/preview/2020-12-16-preview/testbase.json +``` + +### Tag: schema-testbase-2022-04-01-preview and azureresourceschema + +``` yaml $(tag) == 'schema-testbase-2022-04-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas +# all the input files in this apiVersion +input-file: + - Microsoft.TestBase/preview/2022-04-01-preview/testbase.json +``` + +### Tag: schema-testbase-2023-11-01-preview and azureresourceschema +``` yaml $(tag) == 'schema-testbase-2023-11-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas +# all the input files in this apiVersion +input-file: + - Microsoft.TestBase/preview/2023-11-01-preview/testbase.json + - Microsoft.TestBase/preview/2023-11-01-preview/chat.json + - Microsoft.TestBase/preview/2023-11-01-preview/draftpackage.json + - Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json + - Microsoft.TestBase/preview/2023-11-01-preview/customimage.json + - Microsoft.TestBase/preview/2023-11-01-preview/credential.json +``` \ No newline at end of file diff --git a/specification/testbase/resource-manager/readme.go.md b/specification/testbase/resource-manager/readme.go.md index ff7fae0d5ffe..898e274ef21f 100644 --- a/specification/testbase/resource-manager/readme.go.md +++ b/specification/testbase/resource-manager/readme.go.md @@ -2,26 +2,21 @@ These settings apply only when `--go` is specified on the command line. -```yaml $(go) && !$(track2) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - namespace: testbase - clear-output-folder: true -``` - -``` yaml $(go) && $(track2) +```yaml $(go) && $(track2) +azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION module-name: sdk/resourcemanager/testbase/armtestbase module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) -azure-arm: true ``` ### Go multi-api ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-12-16-preview - tag: package-2022-04-01-preview + - tag: package-2023-11-01-preview ``` ### Tag: package-2020-12-16-preview and go @@ -38,6 +33,15 @@ output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-12-16-pr These settings apply only when `--tag=package-2022-04-01-preview --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -```yaml $(tag) == 'package-2020-12-16-preview' && $(go) +```yaml $(tag) == 'package-2022-04-01-preview' && $(go) output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2022-04-01-preview/$(namespace) ``` + +### Tag: package-2023-11-01-preview and go + +These settings apply only when `--tag=package-2023-11-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag) == 'package-2023-11-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2023-11-01-preview/$(namespace) +``` diff --git a/specification/testbase/resource-manager/readme.md b/specification/testbase/resource-manager/readme.md index bdaf8ce5932a..a9db0424099a 100644 --- a/specification/testbase/resource-manager/readme.md +++ b/specification/testbase/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the testbase. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2022-04-01-preview +tag: package-2023-11-01-preview ``` ### Tag: package-2020-12-16-preview @@ -37,10 +37,6 @@ These settings apply only when `--tag=package-2020-12-16-preview` is specified o ```yaml $(tag) == 'package-2020-12-16-preview' input-file: - Microsoft.TestBase/preview/2020-12-16-preview/testbase.json -directive: -- suppress: R4031 - from: testbase.json - reason: provisioningState is not required for Proxy Resources. ``` ### Tag: package-2022-04-01-preview @@ -50,10 +46,20 @@ These settings apply only when `--tag=package-2022-04-01-preview` is specified o ```yaml $(tag) == 'package-2022-04-01-preview' input-file: - Microsoft.TestBase/preview/2022-04-01-preview/testbase.json -directive: -- suppress: R4031 - from: testbase.json - reason: provisioningState is not required for Proxy Resources. +``` + +### Tag: package-2023-11-01-preview + +These settings apply only when `--tag=package-2023-11-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-11-01-preview' +input-file: + - Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json + - Microsoft.TestBase/preview/2023-11-01-preview/chat.json + - Microsoft.TestBase/preview/2023-11-01-preview/customimage.json + - Microsoft.TestBase/preview/2023-11-01-preview/draftpackage.json + - Microsoft.TestBase/preview/2023-11-01-preview/testbase.json + - Microsoft.TestBase/preview/2023-11-01-preview/credential.json ``` --- @@ -72,18 +78,10 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-resource-manager-schemas + after_scripts: + - node sdkauto_afterscript.js testbase/resource-manager - repo: azure-powershell ``` -## Suppression -``` -directive: - - suppress: SECRET_PROPERTY - from: - - Microsoft.TestBase/preview/2022-04-01-preview/testbase.json - where: - - $.definitions.DownloadURLResponse.properties.downloadUrl - reason: Secrets are OK to return in a POST response according to ARM. -``` ## Go @@ -101,4 +99,6 @@ See configuration in [readme.typescript.md](./readme.typescript.md) See configuration in [readme.csharp.md](./readme.csharp.md) +## AzureResourceSchema +See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) diff --git a/specification/web/resource-manager/readme.java.md b/specification/web/resource-manager/readme.java.md index b3052400c140..823e21a683e1 100644 --- a/specification/web/resource-manager/readme.java.md +++ b/specification/web/resource-manager/readme.java.md @@ -1,7 +1,6 @@ ## 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 @@ -12,102 +11,47 @@ payload-flattening-threshold: 1 output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-appservice service-name: AppService directive: - from: WebApps.json - where: $.definitions.MSDeploy.properties.properties - transform: > - delete $.$ref; - $['allOf'] = [{'$ref':'#/definitions/MSDeployCore'}]; - return $; -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2020-09 - - tag: package-2019-08 - - tag: package-2018-02 - - tag: package-2016-03-01-web - - tag: package-2016-08-01-web - - tag: package-2016-09-01-web -``` - -### Tag: package-2020-09 and java - -These settings apply only when `--tag=package-2020-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2020-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.appservice.v2020_09_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/appservice/mgmt-v2020_09_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2019-08 and java - -These settings apply only when `--tag=package-2019-08 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2019-08' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.appservice.v2019_08_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/appservice/mgmt-v2019_08_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-02 and java - -These settings apply only when `--tag=package-2018-02 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-02' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.appservice.v2018_02_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/appservice/mgmt-v2018_02_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-03-01-web and java - -These settings apply only when `--tag=package-2016-03-01-web --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-03-01-web' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.appservice.v2016_03_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/appservice/mgmt-v2016_03_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-08-01-web and java - -These settings apply only when `--tag=package-2016-08-01-web --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-08-01-web' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.appservice.v2016_08_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/appservice/mgmt-v2016_08_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-09-01-web and java - -These settings apply only when `--tag=package-2016-09-01-web --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-09-01-web' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.appservice.v2016_09_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/appservice/mgmt-v2016_09_01 -regenerate-manager: true -generate-interface: true + - from: WebApps.json + where: $.definitions.MSDeploy.properties.properties + transform: > + delete $.$ref; + $['allOf'] = [{'$ref':'#/definitions/MSDeployCore'}]; + return $; + - from: WebApps.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings"].put + transform: > + $["x-ms-long-running-operation"] = true; + reason: Swagger bug. Function App on ACA is LRO. + - from: WebApps.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings"].put.responses + transform: > + $["202"] = { + "description": "Operation is in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/StringDictionary" + } + }; + reason: Swagger bug. Function App on ACA is LRO. + - from: WebApps.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web"].put + transform: > + $["x-ms-long-running-operation"] = true; + reason: Swagger bug. Function App on ACA is LRO. + - from: WebApps.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web"].put.responses + transform: > + $["202"] = { + "description": "Operation is in progress.", + "schema": { + "$ref": "#/definitions/SiteConfigResource" + } + }; + reason: Swagger bug. Function App on ACA is LRO. + - from: WebApps.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}"].patch + transform: > + $["x-ms-long-running-operation"] = true; + reason: Swagger bug. Function App on ACA is LRO. ``` ### Tag: profile-hybrid-2020-09-01 and java